WebZone クラス

定義

public ref class WebZone abstract : System::Web::UI::WebControls::CompositeControl

[System.ComponentModel.Bindable(false)]
public abstract class WebZone : System.Web.UI.WebControls.CompositeControl

[<System.ComponentModel.Bindable(false)>]
type WebZone = class
    inherit CompositeControl

Public MustInherit Class WebZone
Inherits CompositeControl

継承

Object

Control

WebControl

CompositeControl

WebZone

派生

System.Web.UI.WebControls.WebParts.ToolZone

System.Web.UI.WebControls.WebParts.WebPartZoneBase

属性

BindableAttribute

例

次のコード例では、 クラスの使用方法を WebZone 示します。

コード例の最初の部分は、 クラスから派生した 2 つのカスタム コントロールを WebPart 示しています。 コード例を実行するには、このソース コードをコンパイルする必要があります。 明示的にコンパイルし、結果のアセンブリを Web サイトの Bin フォルダーまたはグローバル アセンブリ キャッシュに配置できます。 または、ソース コードをサイトの App_Code フォルダーに配置して、実行時に動的にコンパイルすることもできます。 両方のコンパイル方法を示すチュートリアルについては、「 チュートリアル: カスタム Web サーバー コントロールの開発と使用」を参照してください。

using System;
using System.Security.Permissions;
using System.Web;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

namespace Samples.AspNet.CS.Controls
{
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class CalendarWebPart : WebPart
  {
    Calendar _calendar;

    public CalendarWebPart()
    {
      this.AllowClose = false;
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      _calendar = new Calendar();
      _calendar.Caption = "My Calendar";
      this.Controls.Add(_calendar);
      ChildControlsCreated = true;
    }
  }

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class LinksWebPart : WebPart
  {
    Literal _literal;
    const string _literalText = @"
      <table>
      <tr>
        <td><a href='http://msdn.microsoft.com'>MSDN</a></td>
      </tr>
      <tr>
        <td><a href='http://msn.microsoft.com'>MSN</a></td>
      </tr>
      <tr>
        <td><a href='http://www.msnbc.msn.com'>MSNBC</a></td>
      </tr>
      </table>";

    public LinksWebPart()
    {
      this.AllowClose = false;
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();

      _literal = new Literal();
      _literal.Text = _literalText;
      this.Controls.Add(_literal);

      ChildControlsCreated = true;
    }
  }
}

Imports System.Security.Permissions 
Imports System.Web
Imports System.Web.UI.WebControls 
Imports System.Web.UI.WebControls.WebParts

Namespace Samples.AspNet.VB.Controls

<AspNetHostingPermission(SecurityAction.Demand, _ 
  Level := AspNetHostingPermissionLevel.Minimal)> _ 
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
  Level := AspNetHostingPermissionLevel.Minimal)> _ 
Public Class CalendarWebPart
  Inherits WebPart
  Private _calendar As Calendar

  Public Sub New()
    Me.AllowClose = False

  End Sub

  Protected Overrides Sub CreateChildControls()
      Controls.Clear()
      _calendar = New Calendar()
      _calendar.Caption = "My Calendar"
      Me.Controls.Add(_calendar)
      ChildControlsCreated = True
  
  End Sub 
  
End Class 

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class LinksWebPart
    Inherits WebPart
    Private _literal As Literal
    Private Const _literalText As String = _
      "<table>" & _
      "<tr>" & _
      "<td><a href='http://msdn.microsoft.com'>MSDN</a></td>" & _
      "</tr>" & _
      "<tr>" & _
      "<td><a href='http://msn.microsoft.com'>MSN</a></td>" & _
      "</tr>" & _
      "<tr>" & _
      "<td><a href='http://www.msnbc.msn.com'>MSNBC</a></td>" & _
      "</tr>" & _
      "</table>"

    Public Sub New()
      Me.AllowClose = False

    End Sub


    Protected Overrides Sub CreateChildControls()
      Controls.Clear()

      _literal = New Literal()
      _literal.Text = _literalText
      Me.Controls.Add(_literal)

      ChildControlsCreated = True

    End Sub
  End Class

End Namespace

コード例の 2 番目の部分は、コントロールをホストする Web ページを WebPart 示しています。 宣言型マークアップには、コントロールとコントロールの 2 つの WebPartZone コントロールが CatalogZone 含まれていることに EditorZone 注意してください。

<%@ page language="C#" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuCS" 
  Src="DisplayModeMenuCS.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.CS.Controls" 
  Assembly="ZoneWebPartsCS"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <uc1:DisplayModeMenuCS ID="DisplayModeMenu1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc"/>
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <ZoneTemplate>
          <aspSample:CalendarWebPart 
            runat="server"   
            id="CalendarWebPart1" 
            Title="Calendar WebPart"
            />         
        </ZoneTemplate>
    </asp:webpartzone>
    <asp:webpartzone
      id="WebPartZone2"
      runat="server"
      title="Zone 2"
      PartChromeType="TitleAndBorder"
      EmptyZoneText="Empty Zone">
        <parttitlestyle font-bold="true" ForeColor="#3300cc"/>
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
    </asp:webpartzone>
    <asp:EditorZone ID="editzone1" Runat="server">
      <ZoneTemplate>
        <asp:AppearanceEditorPart 
          ID="appearanceeditor1" 
          Runat="server" />
        <asp:LayoutEditorPart 
          ID="LayoutEditorPart1" 
          Runat="server" />
      </ZoneTemplate>
    </asp:EditorZone>
    <asp:CatalogZone ID="catalogzone1" Runat="server" >
      <ZoneTemplate>
        <asp:DeclarativeCatalogPart 
          ID="declarativepart1" 
          Runat="server">
          <WebPartsTemplate>
          <aspSample:LinksWebPart 
            runat="server"   
            id="linkswebpart" 
            Title="Favorite Links"
            />  
          </WebPartsTemplate>
        </asp:DeclarativeCatalogPart>
      </ZoneTemplate>
    </asp:CatalogZone>
    <br />
  </form>
</body>
</html>

<%@ page language="VB" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuVB" 
  Src="DisplayModeMenuVB.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.VB.Controls" 
  Assembly="ZoneWebPartsVB"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <uc1:DisplayModeMenuVB ID="DisplayModeMenu1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc"/>
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <ZoneTemplate>
          <aspSample:CalendarWebPart 
            runat="server"   
            id="CalendarWebPart1" 
            Title="Calendar WebPart"
            />         
        </ZoneTemplate>
    </asp:webpartzone>
    <asp:webpartzone
      id="WebPartZone2"
      runat="server"
      title="Zone 2"
      PartChromeType="TitleAndBorder"
      EmptyZoneText="Empty Zone">
        <parttitlestyle font-bold="true" ForeColor="#3300cc"/>
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
    </asp:webpartzone>
    <asp:EditorZone ID="editzone1" Runat="server">
      <ZoneTemplate>
        <asp:AppearanceEditorPart 
          ID="appearanceeditor1" 
          Runat="server" />
        <asp:LayoutEditorPart 
          ID="LayoutEditorPart1" 
          Runat="server" />
      </ZoneTemplate>
    </asp:EditorZone>
    <asp:CatalogZone ID="catalogzone1" Runat="server" >
      <ZoneTemplate>
        <asp:DeclarativeCatalogPart 
          ID="declarativepart1" 
          Runat="server">
          <WebPartsTemplate>
          <aspSample:LinksWebPart 
            runat="server"   
            id="linkswebpart" 
            Title="Favorite Links"
            />  
          </WebPartsTemplate>
        </asp:DeclarativeCatalogPart>
      </ZoneTemplate>
    </asp:CatalogZone>
    <br />
  </form>
</body>
</html>

ブラウザーでページを読み込み、さまざまなページ表示モードを切り替えて、さまざまなゾーンの動作を確認できます。 表示モードと、ユーザーが表示モードを切り替える方法の詳細については、「 チュートリアル: Web パーツ ページでの表示モードの変更」を参照してください。

注釈

Web パーツ ゾーンは、Web ページ上のサーバー コントロールを含む定義済みの領域であり、含まれているコントロールに対して一貫したユーザー インターフェイス (UI)、レイアウト、およびレンダリングを提供します。 ゾーンは HTML テーブルとしてブラウザーでレンダリングされます。

クラスは WebZone 、すべての Web パーツ ゾーンの基本クラスです。 ゾーン コントロールは、他のコントロールを格納するように設計された複合コントロールであるため、クラスは WebZone クラスから CompositeControl 継承されます。 WebPartManagerコントロールとPartコントロール (またはゾーンに配置できる他のユーザーまたはサーバー コントロール) と共に、基本クラスからWebZone派生したゾーン コントロールは、Web パーツ アプリケーションの重要な構成要素を形成します。

Web パーツ ゾーンの重要な役割は、含まれているコントロールに対して完全な Web パーツ機能を有効にすることです。 すべての Web パーツ ページには少なくとも 1 つのゾーンが含まれており、ゾーンには 0 個以上のパーツ コントロールを含めることができます。 Web パーツ機能にはゾーンが必要です。 ゾーンがない場合、クラスから WebPart 派生したコントロールであっても、Web パーツ機能がほとんどない場合があります。 逆に、Web パーツ コントロール セットの設計により、通常の ASP.NET コントロール、サーバー コントロール、またはユーザー コントロールを (からWebZone派生した) ゾーンにWebPartZoneBase配置できます。また、ゾーン内にあるため、これらの通常のサーバー コントロールは実行時にコントロールとしてWebPart機能できます。 詳細については、 クラスのドキュメントを GenericWebPart 参照してください。

Web パーツ コントロール セットには 2 つの広範なカテゴリのゾーンがあり、そのすべてが基本 WebZone クラスから継承されます。

• WebPartZoneBase ゾーン。 これには (およびその他のサーバーとユーザー) コントロールが含 WebPart まれており、ユーザーがほとんどの場合操作する Web パーツ ページのプライマリ UI を形成します。

• ToolZone ゾーン。 これらのゾーンは、Web パーツ ページの特別なビューを提供します。これにより、ユーザーは Web パーツ ページ上のゾーンに含まれる WebPartZoneBase コントロールのコンテンツ、レイアウト、外観、動作、およびプロパティを変更 (カスタマイズ) できます。 たとえば、 CatalogZoneBase ゾーンは ToolZone 、ユーザーがサーバー コントロールを追加および削除できるように、ページのカタログ ビューを提供する です。 EditorZoneBaseゾーンは、ページの編集ビューを提供する別のToolZone種類であり、ユーザーはコントロールのプロパティ、外観、および動作と共にページのレイアウトを変更および編集できます。

Web パーツ コントロール セット内の各ゾーンには、 クラスから派生した対応する種類のコントロールが Part 含まれるように設計されており、パーツ コントロールはゾーンのメイン コンテンツおよびプライマリ UI として機能します。 Web パーツ コントロール セット内のゾーン型と、それに含まれるパーツ コントロールの対応する種類を次の表に示します。

Web パーツ コントロール内のすべてのゾーンには、基本 WebZone クラスから継承される基本的で一般的なユーザー インターフェイス要素があります。 これらの要素がすべてすべてのゾーンに表示されるわけではありませんが、次の表で説明するように、各ゾーンの種類には、これらの共通のゾーン関連の UI 要素を含めることができます。

クラスの WebZone プロパティのほとんどは、ゾーンの一般的な UI 要素について説明する前の表で説明されています。 WebZoneクラスには、コンテンツのレンダリングの役割に関連するいくつかのメソッドもあります。 RenderContents、RenderBody、RenderFooter、および RenderHeader のすべてのメソッドをオーバーライドして、ゾーンの各特定のセクションのレンダリングをプログラムで制御できます。 たとえば、アプリケーション内のカタログ ゾーンのすべてのフッター セクションのレンダリングをカスタマイズする場合は、 クラスから継承し、 からCatalogZoneBaseWebZone継承されたメソッドをRenderFooterオーバーライドし、フッター セクションのレンダリングを変更できます。

注意 (実装者)

カスタム Web パーツ ゾーンを開発するために、 WebZone クラスから直接継承する必要はほとんどありません。 Web パーツ コントロール セットには、上記の「解説」セクションに記載されている特殊なゾーンが含まれています。通常は、いずれかのゾーンから派生して、カスタム動作をゾーンに追加できます。 クラスから WebZone 直接継承する場合は、いくつかのプロパティとメソッドをオーバーライドする必要があります (クラスのメンバーのドキュメントを WebZone 参照してください)。 また、カスタム WebPartManager コントロール、必要に応じてカスタム WebPartDisplayMode コントロールを作成して、ゾーンを表示する一意の表示モードを作成する必要があります。また、Web パーツ コントロール セット内でゾーンを動作させるには、その他のカスタマイズも行う必要があります。

プロパティ

メソッド

イベント

明示的なインターフェイスの実装

拡張メソッド

適用対象

こちらもご覧ください

• ASP.NET Web パーツの概要
• Web パーツ コントロール セットの概要
• チュートリアル: Web パーツ ページでの表示モードの変更
• ASP.NET Web パーツ コントロール