EditorZone クラス

定義

public ref class EditorZone : System::Web::UI::WebControls::WebParts::EditorZoneBase

public class EditorZone : System.Web.UI.WebControls.WebParts.EditorZoneBase

type EditorZone = class
    inherit EditorZoneBase

Public Class EditorZone
Inherits EditorZoneBase

継承

Object

Control

WebControl

CompositeControl

WebZone

ToolZone

EditorZoneBase

EditorZone

例

次のコード例では、 クラスの宣言型およびプログラム的な使用方法 EditorZone をいくつか示します。 この例では、 クラスを継承するカスタム エディター ゾーンを EditorZone 作成し、Web パーツ ページで使用します。

このコード例には、次の 3 つの部分があります。

• Web ページの表示モードを変更できるユーザー コントロール。

• カスタム EditorZone コントロールを参照する Web ページ。

• この例の動作の説明。

このコード例の最初の部分は、ユーザーが Web ページの表示モードを変更できるようにするユーザー コントロールです。 表示モードの詳細と、このコントロールのソース コードの説明については、「 チュートリアル: Web パーツ ページでの表示モードの変更」を参照してください。

<%@ control language="C#" classname="DisplayModeMenuCS"%>

<script runat="server">
  
 // Use a field to reference the current WebPartManager.
  WebPartManager _manager;

  void Page_Init(object sender, EventArgs e)
  {
    Page.InitComplete += new EventHandler(InitComplete);
  }  

  void InitComplete(object sender, System.EventArgs e)
  {
    _manager = WebPartManager.GetCurrentWebPartManager(Page);

    String browseModeName = WebPartManager.BrowseDisplayMode.Name;

    // Fill the dropdown with the names of supported display modes.
    foreach (WebPartDisplayMode mode in _manager.SupportedDisplayModes)
    {
      String modeName = mode.Name;
      // Make sure a mode is enabled before adding it.
      if (mode.IsEnabled(_manager))
      {
        ListItem item = new ListItem(modeName + " Mode", modeName);
        DisplayModeDropdown.Items.Add(item);
      }
    }

  }
 
  // Change the page to the selected display mode.
  void DisplayModeDropdown_SelectedIndexChanged(object sender, 
    EventArgs e)
  {
    String selectedMode = DisplayModeDropdown.SelectedValue;

    WebPartDisplayMode mode = _manager.SupportedDisplayModes[selectedMode];
    if (mode != null)
      _manager.DisplayMode = mode;

  }

  void Page_PreRender(object sender, EventArgs e)
  {
    DisplayModeDropdown.SelectedValue = _manager.DisplayMode.Name;
  }
  
</script>
<div>
  <asp:DropDownList ID="DisplayModeDropdown" 
    runat="server"  
    AutoPostBack="true" 
    OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
</div>

<%@ control language="vb" classname="DisplayModeMenuVB"%>

<script runat="server">
  
' Use a field to reference the current WebPartManager.
Dim _manager As WebPartManager


Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs) 
    AddHandler Page.InitComplete, AddressOf InitComplete

End Sub 


Sub InitComplete(ByVal sender As Object, ByVal e As System.EventArgs) 
    _manager = WebPartManager.GetCurrentWebPartManager(Page)
    
    Dim browseModeName As String = WebPartManager.BrowseDisplayMode.Name
    
    ' Fill the dropdown with the names of supported display modes.
    Dim mode As WebPartDisplayMode
    For Each mode In  _manager.SupportedDisplayModes
        Dim modeName As String = mode.Name
        ' Make sure a mode is enabled before adding it.
        If mode.IsEnabled(_manager) Then
            Dim item As New ListItem(modeName + " Mode", modeName)
            DisplayModeDropdown.Items.Add(item)
        End If
    Next mode

End Sub 
 

' Change the page to the selected display mode.
Sub DisplayModeDropdown_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs) 
    Dim selectedMode As String = DisplayModeDropdown.SelectedValue
    
    Dim mode As WebPartDisplayMode = _manager.SupportedDisplayModes(selectedMode)
    If Not (mode Is Nothing) Then
        _manager.DisplayMode = mode
    End If
 
End Sub 


Sub Page_PreRender(ByVal sender As Object, ByVal e As EventArgs) 
    DisplayModeDropdown.SelectedValue = _manager.DisplayMode.Name

End Sub 

</script>
<div>
  <asp:DropDownList ID="DisplayModeDropdown" 
    runat="server"  
    AutoPostBack="true" 
    OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
</div>

コード例の 2 番目の部分は Web ページです。 ページの上部付近には、 Register ユーザー コントロールの ディレクティブがあります。 ユーザー コントロール タグは、 要素のプレフィックスを uc1: 持つページで宣言されます。 要素の<asp:WebPartZone>下には、いくつかのEditorPartコントロールを<asp:EditorZone>含む要素があり、その外観と動作を決定するためにいくつかのタグとプロパティが設定されていることに注意してください。 プログラムによってコントロールのさまざまなメンバー EditorZone にアクセスするメソッドも多数あります。

<%@ Page Language="C#" %>
<%@ register tagprefix="uc1" 
  tagname="DisplayModeMenuCS" 
  src="displaymodecs.ascx" %>
  
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
  // <snippet3>

  void Button1_Click(object sender, EventArgs e)
  {
    if (EditorZone1.ApplyVerb.Enabled == true)
      EditorZone1.ApplyVerb.Enabled = false;
    else
      EditorZone1.ApplyVerb.Enabled = true;
  }

  void Button2_Click(object sender, EventArgs e)
  {
    EditorZone1.BorderWidth = 2;
    EditorZone1.BorderColor = System.Drawing.Color.DarkBlue;
  }

  void Button3_Click(object sender, EventArgs e)
  {
    Label1.Text = "<br />";
    foreach (EditorPart part in EditorZone1.EditorParts)
    {
      Label1.Text += part.ID + "<br />";
    }
  }

  void Button4_Click(object sender, EventArgs e)
  {
    EditorZone1.InstructionText = "My custom instruction text.";
  }
  // </snippet3>
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
  <title>EditorZoneBase Examples</title>
</head>
<body>
  <form id="form1" runat="server">
    <asp:WebPartManager ID="mgr" runat="server" />
    <uc1:DisplayModeMenuCS runat="server" id="displaymodemenu1" />
    <asp:WebPartZone ID="WebPartZone1" runat="server">
      <ZoneTemplate>
        <asp:BulletedList 
          ID="BulletedList1" 
          Runat="server"
          DisplayMode="HyperLink" 
          Title="Favorite Links" >
          <asp:ListItem Value="http://msdn.microsoft.com">
            MSDN
          </asp:ListItem>
          <asp:ListItem Value="http://www.asp.net">
            ASP.NET
          </asp:ListItem>
          <asp:ListItem Value="http://www.msn.com">
            MSN
          </asp:ListItem>
        </asp:BulletedList>
        <asp:Calendar ID="Calendar1" Runat="server" 
          Title="My Calendar" />
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:EditorZone ID="EditorZone1" runat="server" >
      <VerbStyle Font-Italic="true" />
      <EditUIStyle BackColor="lightgray" />
      <PartChromeStyle BorderWidth="1" />
      <LabelStyle Font-Bold="true" />
      <CancelVerb Text="Cancel Changes" />
      <ZoneTemplate>
        <asp:AppearanceEditorPart ID="AppearanceEditorPart1" 
          runat="server" />
        <asp:LayoutEditorPart ID="LayoutEditorPart1" 
          runat="server" />
      </ZoneTemplate>
    </asp:EditorZone>
    <hr />
    <asp:Button ID="Button1" runat="server" Width="200"
      Text="Enable or Disable Apply" OnClick="Button1_Click" />
    <br />
    <asp:Button ID="Button2" runat="server" Width="200"
      Text="Set Zone BorderColor" OnClick="Button2_Click" />
    <br />
    <asp:Button ID="Button3" runat="server" Width="200"
      Text="Display EditorPart Collection" OnClick="Button3_Click" />
    <asp:Label ID="Label1" runat="server" />
    <br />
    <asp:Button ID="Button4" runat="server" Width="200"
      Text="Set Instruction Text" OnClick="Button4_Click" /> 
  </form>
</body>
</html>

<%@ Page Language="vb" %>
<%@ register tagprefix="uc1" 
  tagname="DisplayModeMenuVB" 
  src="displaymodevb.ascx" %>
  
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
  ' <snippet3>

  Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)
    If EditorZone1.ApplyVerb.Enabled = True Then
      EditorZone1.ApplyVerb.Enabled = False
    Else
      EditorZone1.ApplyVerb.Enabled = True
    End If
  End Sub
 
  Sub Button2_Click(ByVal sender As Object, ByVal e As EventArgs)
    EditorZone1.BorderWidth = 2
    EditorZone1.BorderColor = System.Drawing.Color.DarkBlue
  End Sub

  Sub Button3_Click(ByVal sender As Object, ByVal e As EventArgs)
    Label1.Text = "<br />"
    Dim part As EditorPart
    For Each part In EditorZone1.EditorParts
      Label1.Text += part.ID + "<br />"
    Next part
  End Sub

  Sub Button4_Click(ByVal sender As Object, ByVal e As EventArgs)
    EditorZone1.InstructionText = "My custom instruction text."
  End Sub
  ' </snippet3>
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
  <title>EditorZoneBase Examples</title>
</head>
<body>
  <form id="form1" runat="server">
    <asp:WebPartManager ID="mgr" runat="server" />
    <uc1:DisplayModeMenuVB runat="server" id="displaymodemenu1" />
    <asp:WebPartZone ID="WebPartZone1" runat="server">
      <ZoneTemplate>
        <asp:BulletedList 
          ID="BulletedList1" 
          Runat="server"
          DisplayMode="HyperLink" 
          Title="Favorite Links" >
          <asp:ListItem Value="http://msdn.microsoft.com">
            MSDN
          </asp:ListItem>
          <asp:ListItem Value="http://www.asp.net">
            ASP.NET
          </asp:ListItem>
          <asp:ListItem Value="http://www.msn.com">
            MSN
          </asp:ListItem>
        </asp:BulletedList>
        <asp:Calendar ID="Calendar1" Runat="server" 
          Title="My Calendar" />
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:EditorZone ID="EditorZone1" runat="server" >
      <VerbStyle Font-Italic="true" />
      <EditUIStyle BackColor="lightgray" />
      <PartChromeStyle BorderWidth="1" />
      <LabelStyle Font-Bold="true" />
      <CancelVerb Text="Cancel Changes" />
      <ZoneTemplate>
        <asp:AppearanceEditorPart ID="AppearanceEditorPart1" 
          runat="server" />
        <asp:LayoutEditorPart ID="LayoutEditorPart1" 
          runat="server" />
      </ZoneTemplate>
    </asp:EditorZone>
    <hr />
    <asp:Button ID="Button1" runat="server" Width="200"
      Text="Enable or Disable Apply" OnClick="Button1_Click" />
    <br />
    <asp:Button ID="Button2" runat="server" Width="200"
      Text="Set Zone BorderColor" OnClick="Button2_Click" />
    <br />
    <asp:Button ID="Button3" runat="server" Width="200"
      Text="Display EditorPart Collection" OnClick="Button3_Click" />
    <asp:Label ID="Label1" runat="server" />
    <br />
    <asp:Button ID="Button4" runat="server" Width="200"
      Text="Set Instruction Text" OnClick="Button4_Click" /> 
  </form>
</body>
</html>

ブラウザーでページを読み込むとき、ドロップダウン リストで [編集モード ] を選択して編集モードに切り替えることができます。 編集 UI を表示するには、2 つのコントロールのタイトル バーにある動詞メニュー (下向き矢印) をクリックし、[ 編集 ] をクリックしてコントロールを編集します。 編集 UI が表示された状態で、クラス メンバーの宣言型およびプログラムによる使用の効果を EditorZone 確認できます。

注釈

Web パーツ コントロール セット内のゾーンは、Web ページ上の定義された領域をカバーし、サーバー コントロールを含む複合コントロールです。 ゾーンの主な機能は、ゾーンに含まれるコントロールをレイアウトし、それらのコントロールに共通のユーザー インターフェイス (UI) を提供することです。 Web パーツ アプリケーションでのゾーンとその使用方法に関する一般的な情報については、基本 WebZone クラスのリファレンス ドキュメントと Web パーツ コントロール セットの概要に関するページを参照してください。

コントロールは EditorZone 、Web パーツ コントロール セットの基本的なコントロールの 1 つです。 Web パーツの主な機能は、エンド ユーザーが自分の好みに応じて Web ページを変更 (またはカスタマイズ) し、今後のブラウザー セッション用に個人用設定を保存できることです。 Web パーツ ページを変更する 1 つの側面には、編集が含まれます。ユーザーは、表示 WebPart されているコントロールの外観、レイアウト、動作、およびその他のプロパティを編集できます。 Web パーツ コントロール セット内のいくつかのコントロールは、コントロールを含む編集機能を提供します EditorZone 。

コントロールはEditorZone、Web パーツ ページが編集モードになると表示され、コントロールのカスタマイズWebPartに使用できるさまざまなEditorPartコントロールを使用できるようになります。 コントロールは EditorZone 親クラスとよく似ていますが、 EditorZoneBase 1 つの重要な違いがあります。コントロールは EditorZone 、そのプロパティで参照されるゾーン テンプレートを ZoneTemplate 提供します。 ゾーン テンプレートは、ページ永続化形式でコンテンツを宣言する機能を追加します。 ページ開発者は、Web ページの宣言型マークアップにコントロールを配置 EditorZone したり、子 <zonetemplate> 要素を追加したり、要素内で <zonetemplate> コントロールへの宣言参照を EditorPart 追加したりできます。

EditorZoneコントロールには、 CreateEditorPartsクラスの基本メソッドをオーバーライドする メソッドEditorZoneBaseもあります。 このメソッドは、コントロールがゾーン テンプレートを EditorZone 作成して、ゾーンに宣言的に追加されるコントロールを含 EditorPart めるために必要です。

ユーザー補助

このコントロールに対して既定でレンダリングされるマークアップは、Web コンテンツ アクセシビリティ ガイドライン 1.0 (WCAG) 優先度 1 のガイドラインなどのアクセシビリティ標準に準拠していない可能性があります。 このコントロールのアクセシビリティサポートの詳細については、「 ASP.NET コントロールとアクセシビリティ」を参照してください。

注意 (継承者)

編集 UI のレンダリングをより細かく制御できるようにカスタム EditorZone ゾーンを作成する場合は、ページ開発者がゾーンにコントロールを宣言的に追加EditorPartするためにゾーン テンプレートのサポートを提供する必要がない限り、クラスからEditorZoneBase直接継承できます。 このような場合は、プログラムによってすべての EditorPart コントロールをゾーンに追加します。 ゾーン テンプレートのサポートを提供する場合は、 クラスから継承する EditorZone 必要があります。

コンストラクター

プロパティ

メソッド

イベント

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

拡張メソッド

適用対象

こちらもご覧ください

• EditorPart
• Web パーツ コントロール セットの概要
• Web パーツのパーソナル化の概要
• ASP.NET Web パーツ コントロール