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 クラスの使用方法を示しています。

コード例の最初の部分は、 WebPart クラスから派生する 2 つのカスタム コントロールを示しています。 コード例を実行するには、このソース コードをコンパイルする必要があります。 明示的にコンパイルし、結果のアセンブリを 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 番目の部分は、 WebPart コントロールをホストする Web ページを示しています。 宣言型マークアップには、CatalogZone コントロールとEditorZone コントロールの 2 つのWebPartZone コントロールが含まれていることに注意してください。

<%@ 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 クラスには、コンテンツのレンダリングの役割に関連するいくつかのメソッドもあります。 RenderBody、RenderContents、RenderFooter、およびRenderHeaderメソッドはすべてオーバーライドして、ゾーンの各特定のセクションのレンダリングをプログラムで制御できます。 たとえば、アプリケーション内のカタログ ゾーンのすべてのフッター セクションのレンダリングをカスタマイズする場合は、CatalogZoneBase クラスから継承し、WebZoneから継承されたRenderFooter メソッドをオーバーライドし、フッター セクションのレンダリングを変更できます。

注意 (実装者)

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

こちらもご覧ください

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