WebZone クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

WebZone クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

Web パーツアプリケーションでサーバーコントロール (Web パーツの Part コントロール、サーバーコントロール、およびユーザーコントロールを含む) のコンテナとして機能する、すべてのコントロールの基本クラスとして使用されます。

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

<BindableAttribute(False)> _
Public MustInherit Class
 WebZone
    Inherits CompositeControl

Visual Basic (使用法)

Dim instance As WebZone

[BindableAttribute(false)] 
public abstract class WebZone : CompositeControl

C++

[BindableAttribute(false)] 
public ref class WebZone abstract : public
 CompositeControl

/** @attribute BindableAttribute(false) */ 
public abstract class WebZone extends CompositeControl

JScript

BindableAttribute(false) 
public abstract class WebZone extends
 CompositeControl

解説

Web パーツゾーンは、サーバーコントロールが含まれている Web ページ上の定義領域で、格納するコントロールに一貫性のあるユーザーインターフェイス (UI: User Interface)、レイアウト、および表示を提供します。ゾーンは HTML テーブルとしてブラウザに表示されます。

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

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

メモ
Part コントロールや WebPart コントロールをページのゾーン外に追加することはできますが、その場合、これらのコントロールは単に通常のサーバーコントロールとして機能します。

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

WebPartZoneBase ゾーン。これらには WebPart コントロール (および他のサーバーコントロールやユーザーコントロール) が含まれ、ユーザーとの対話の大半を占める、Web パーツページの基本 UI を形成します。
ToolZone ゾーン。これらのゾーンは、Web パーツページ上の WebPartZoneBase ゾーンに含まれる各コントロールの内容、レイアウト、外観、動作、およびプロパティを変更 (パーソナル化) できるようにする、Web パーツページの特殊なビューを提供します。たとえば、CatalogZoneBase ゾーンは、ページのカタログビューを提供する ToolZone で、ユーザーがサーバーコントロールを追加したり削除したりできるようにします。EditorZoneBase ゾーンは、ページの編集ビューを提供する別の種類の ToolZone で、ページのレイアウトのほか、コントロールのプロパティ、外観、および動作の変更や編集をユーザーが行うことができるようにします。

Web パーツコントロールセット内の各ゾーンは、そのゾーンの主要なコンテンツおよび基本 UI として機能するパーツコントロールと共に、Part クラスから派生した対応する種類のコントロールを格納するように設計されています。次の表に、Web パーツコントロールセットのゾーンの種類と、それらに格納される対応する種類のパーツコントロールを示します。

パーツコントロールの種類	ゾーンの種類
WebPart (および実行時に GenericWebPart でラップされるサーバーコントロールとユーザーコントロール)	WebPartZone (基本クラスは WebPartZoneBase)
EditorPart (いくつかの派生コントロールは Web パーツコントロールセットと共に提供され、カスタム EditorPart コントロールを開発できます)	EditorZone (基本クラスは EditorZoneBase)
CatalogPart (いくつかの派生コントロールは Web パーツコントロールセットと共に提供され、カスタム CatalogPart コントロールを開発できます)	CatalogZone (基本クラスは CatalogZoneBase)
WebPartConnection (接続コントロールは、基本クラスから継承したパーツコントロールでないという点で独特です)	ConnectionsZone (ToolZone から直接継承)

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

ゾーンセクション	説明
ヘッダー	ゾーンのトップセクション。これには、ゾーンのタイトルを含めることができるヘッダーテキスト、ヘッダーを目立たせるスタイル属性 (境界線や背景色など)、および、クリックすることで、ゾーンを閉じるなどのゾーン全体に適用される UI 操作を実行できる、ゾーンレベルの動詞 (ボタン、ハイパーリンク、またはイメージで表される) が含まれます。HasHeader、HeaderStyle、HeaderText など、ゾーンのヘッダー領域に関係するいくつかの WebZone プロパティ。ゾーンにゾーンレベルの動詞がある場合、VerbButtonType プロパティと VerbStyle プロパティがそれらに適用されます。これら 2 つの動詞プロパティは、ゾーンレベルの動詞だけに適用され、ゾーンに含まれる個々のパーツコントロールの動詞には適用されないことに注意してください。ヘッダーはすべての種類のゾーンに存在するわけではありません。通常は、テキストおよび動詞 (閉じる動詞など) を含んだ共通のヘッダー領域を持つ必要がある ToolZone ゾーンに表示されます。
本体	ゾーンのメインコンテンツのセクションです。WebZone から派生したすべてのゾーンに、本体セクションがあります。前述の表に示したように、Web パーツコントロールセットのすべての種類のゾーンで、ゾーンの種類に対応する指定された種類の Part コントロール (またはその他のサーバーコントロール) がゾーンの本体に含まれます。BackImageUrl、PartChromeStyle、PartChromeType、PartStyle の各プロパティなど、WebZone クラスのさまざまなメンバが、本体セクションのコンテンツに影響を与えます。本体セクションが空の場合、特定の状況では、EmptyZoneText メッセージを表示できます。
クロム	ゾーン内の各パーツコントロールのために表示される共通の UI 要素。これは、ゾーン自体に適用されるスタイル属性とは異なります。具体的には、クロムは格納されているパーツコントロールに適用されます。クロムには、動詞、境界線、および背景色、タイトルテキストのフォントスタイルなど、ゾーンのパーツコントロールに対するその他のスタイル属性が含まれます。ゾーンは、格納しているパーツコントロールの種類に適切な単一のクロムオブジェクト (たとえば、CatalogPart コントロールを格納した CatalogZone には CatalogPartChrome オブジェクト) を使用して、クロムの詳細を決定します。この単一のクロムオブジェクトが、クロムの詳細およびゾーン内のすべてのパーツコントロールの描画を処理します。これにより開発者は、一貫性のある共通のルックアンドフィールをすべてのパーツコントロールに指定できるゾーンを作成できます。ゾーンのパーツコントロールのクロムに関係するプロパティには、PartChromeStyle、PartChromeType、PartStyle、PartTitleStyle の各プロパティなどが含まれます。特定の種類のゾーンのクロムオブジェクトを参照する特定のプロパティを含め、ほとんどのクロム関連プロパティは、基本 WebZone クラスでは実装されていません。代わりに、ゾーンのほとんどのクロム固有機能は、パーツコントロールに固有の要求に合うように特定のゾーンの種類で実装されています。このトピックの前述の表に記載されている、各ゾーンの種類のトピックを参照してください。
パーツコントロール	ゾーンの本体セクションに存在するコントロール。このトピックの前述の表に示したように、WebZone クラスから継承したすべてのゾーンでは、対応する種類のパーツコントロールが、その本体セクションに 1 つ以上含まれています。これらのパーツコントロールが、Web パーツアプリケーションの主要な UI を形成します。WebZone から派生したほとんどのゾーンの種類には、WebPartZoneBase クラスの WebParts プロパティや、EditorZoneBase クラスの EditorParts プロパティなど、格納しているすべてのパーツコントロールを参照できるようにするコレクションプロパティがあります。
Footer	ゾーンの下部セクション。ヘッダーセクションと同様、これはすべての種類のゾーンに存在するのではなく、通常は ToolZone ゾーンに出現します。フッターセクションの一般的なコンテンツは、EditorZoneBase ゾーンのフッターに表示される ok の動詞や適用の動詞などの動詞です。HasFooter、FooterStyle、VerbButtonType、VerbStyle の各プロパティなど、フッターセクションに関連するいくつかのプロパティがあります。

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

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

使用例

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

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

Visual Basic

Imports System
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

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;
    }
  }
}

コード例の 2 番目の部分は、WebPart コントロールをホストする Web ページです。宣言型マークアップには、CatalogZone コントロールおよび EditorZone コントロールの 2 つの WebPartZone コントロールが含まれます。

Visual Basic

<%@ page language="VB" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuVB" 
  Src="DisplayModeMenuVB.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.VB.Controls"
 
  Assembly="ZoneWebPartsVB"%>
<script runat="server">

</script>
<html>
<head id="Head1" runat="server">
  
</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>

<%@ page language="C#" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuCS" 
  Src="DisplayModeMenuCS.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.CS.Controls" 
  Assembly="ZoneWebPartsCS"%>
<script runat="server">

</script>
<html>
<head id="Head1" runat="server">
  
</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>

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

.NET Framework のセキュリティ

AspNetHostingPermission (ホスト環境での動作に必要なアクセス許可)要求値 : LinkDemand; アクセス許可値 : Minimal。
AspNetHostingPermission (ホスト環境での動作に必要なアクセス許可)要求値 : InheritanceDemand; アクセス許可値 : Minimal。

継承階層

System.Object
   System.Web.UI.Control
     System.Web.UI.WebControls.WebControl
       System.Web.UI.WebControls.CompositeControl
        System.Web.UI.WebControls.WebParts.WebZone
           System.Web.UI.WebControls.WebParts.ToolZone
           System.Web.UI.WebControls.WebParts.WebPartZoneBase

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。