BehaviorEditorPart クラス

定義

public ref class BehaviorEditorPart sealed : System::Web::UI::WebControls::WebParts::EditorPart

public sealed class BehaviorEditorPart : System.Web.UI.WebControls.WebParts.EditorPart

type BehaviorEditorPart = class
    inherit EditorPart

Public NotInheritable Class BehaviorEditorPart
Inherits EditorPart

継承

Object

Control

WebControl

Panel

Part

EditorPart

BehaviorEditorPart

例

次のコード例は、Web ページで BehaviorEditorPart コントロールを宣言し、 WebPart コントロールのいくつかの UI プロパティを編集できるようにする方法を示しています。 このコード例には、次の 4 つの部分があります。

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

• EditorZone コントロールとBehaviorEditorPart コントロールを含む Web ページ。BulletedList コントロールの動作プロパティを編集するために使用されます。

• 共有パーソナル化スコープでページを編集する権限を付与する、Web.config ファイル内に作成するエントリ。

• ブラウザーでページを読み込むときにこの例がどのように機能するかの説明。

このコード例の最初の部分は、ユーザーが Web ページの表示モードを変更できるようにするユーザー コントロールです。 表示モードの詳細と、このコントロールのソース コードの説明については、「 チュートリアル: Web パーツ ページでの表示モードの変更」を参照してください。 このユーザー コントロールのドキュメントでは、 ToggleScope メソッドを呼び出してページを共有モードに切り替え、 BehaviorEditorPart コントロールを表示する方法について説明します。

<%@ 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, modeName);
        DisplayModeDropdown.Items.Add(item);
      }
    }

    // If shared scope is allowed for this user, display the scope-switching
    // UI and select the appropriate radio button for the current user scope.
    if (_manager.Personalization.CanEnterSharedScope)
    {
      Panel2.Visible = true;
      if (_manager.Personalization.Scope == PersonalizationScope.User)
        RadioButton1.Checked = true;
      else
        RadioButton2.Checked = true;
    }
    
  }
 
  // 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;
  }

  // Set the selected item equal to the current display mode.
  void Page_PreRender(object sender, EventArgs e)
  {
    ListItemCollection items = DisplayModeDropdown.Items;
    int selectedIndex = 
      items.IndexOf(items.FindByText(_manager.DisplayMode.Name));
    DisplayModeDropdown.SelectedIndex = selectedIndex;
  }

  // Reset all of a user's personalization data for the page.
  protected void LinkButton1_Click(object sender, EventArgs e)
  {
    _manager.Personalization.ResetPersonalizationState();
  }

  // If not in User personalization scope, toggle into it.
  protected void RadioButton1_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.Scope == PersonalizationScope.Shared)
      _manager.Personalization.ToggleScope();
  }

  // If not in Shared scope, and if user is allowed, toggle the scope.
  protected void RadioButton2_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.CanEnterSharedScope && 
        _manager.Personalization.Scope == PersonalizationScope.User)
      _manager.Personalization.ToggleScope();
  }
</script>
<div>
  <asp:Panel ID="Panel1" runat="server" 
    Borderwidth="1" 
    Width="230" 
    BackColor="lightgray"
    Font-Names="Verdana, Arial, Sans Serif" >
    <asp:Label ID="Label1" runat="server" 
      Text="&nbsp;Display Mode" 
      Font-Bold="true"
      Font-Size="8"
      Width="120" 
      AssociatedControlID="DisplayModeDropdown"/>
    <asp:DropDownList ID="DisplayModeDropdown" runat="server"  
      AutoPostBack="true" 
      Width="120"
      OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
    <asp:LinkButton ID="LinkButton1" runat="server"
      Text="Reset User State" 
      ToolTip="Reset the current user's personalization data for the page."
      Font-Size="8" 
      OnClick="LinkButton1_Click" />
    <asp:Panel ID="Panel2" runat="server" 
      GroupingText="Personalization Scope"
      Font-Bold="true"
      Font-Size="8" 
      Visible="false" >
      <asp:RadioButton ID="RadioButton1" runat="server" 
        Text="User" 
        AutoPostBack="true"
        GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
      <asp:RadioButton ID="RadioButton2" runat="server" 
        Text="Shared" 
        AutoPostBack="true"
        GroupName="Scope" 
        OnCheckedChanged="RadioButton2_CheckedChanged" />
    </asp:Panel>
  </asp:Panel>
</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, modeName)
        DisplayModeDropdown.Items.Add(item)
      End If
    Next mode
      
    ' If shared scope is allowed for this user, display the scope-switching
    ' UI and select the appropriate radio button for the current user scope.
    If _manager.Personalization.CanEnterSharedScope Then
      Panel2.Visible = True
      If _manager.Personalization.Scope = PersonalizationScope.User Then
        RadioButton1.Checked = True
      Else
        RadioButton2.Checked = True
      End If
    End If
   
  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
   
  ' Set the selected item equal to the current display mode.
  Sub Page_PreRender(ByVal sender As Object, ByVal e As EventArgs)
    Dim items As ListItemCollection = DisplayModeDropdown.Items
    Dim selectedIndex As Integer = _
      items.IndexOf(items.FindByText(_manager.DisplayMode.Name))
    DisplayModeDropdown.SelectedIndex = selectedIndex

  End Sub

  ' Reset all of a user's personalization data for the page.
  Protected Sub LinkButton1_Click(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    _manager.Personalization.ResetPersonalizationState()
    
  End Sub

  ' If not in User personalization scope, toggle into it.
  Protected Sub RadioButton1_CheckedChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    If _manager.Personalization.Scope = PersonalizationScope.Shared Then
      _manager.Personalization.ToggleScope()
    End If

  End Sub
   
  ' If not in Shared scope, and if user is allowed, toggle the scope.
  Protected Sub RadioButton2_CheckedChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    If _manager.Personalization.CanEnterSharedScope AndAlso _
      _manager.Personalization.Scope = PersonalizationScope.User Then
      _manager.Personalization.ToggleScope()
    End If

  End Sub

</script>
<div>
  <asp:Panel ID="Panel1" runat="server" 
    Borderwidth="1" 
    Width="230" 
    BackColor="lightgray"
    Font-Names="Verdana, Arial, Sans Serif" >
    <asp:Label ID="Label1" runat="server" 
      Text="&nbsp;Display Mode" 
      Font-Bold="true"
      Font-Size="8"
      Width="120" 
      AssociatedControlID="DisplayModeDropdown"/>
    <asp:DropDownList ID="DisplayModeDropdown" runat="server"  
      AutoPostBack="true" 
      Width="120"
      OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
    <asp:LinkButton ID="LinkButton1" runat="server"
      Text="Reset User State" 
      ToolTip="Reset the current user's personalization data for the page."
      Font-Size="8" 
      OnClick="LinkButton1_Click" />
    <asp:Panel ID="Panel2" runat="server" 
      GroupingText="Personalization Scope"
      Font-Bold="true"
      Font-Size="8" 
      Visible="false" >
      <asp:RadioButton ID="RadioButton1" runat="server" 
        Text="User" 
        AutoPostBack="true"
        GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
      <asp:RadioButton ID="RadioButton2" runat="server" 
        Text="Shared" 
        AutoPostBack="true"
        GroupName="Scope" 
        OnCheckedChanged="RadioButton2_CheckedChanged" />
    </asp:Panel>
  </asp:Panel>
</div>

コード例の 2 番目の部分は Web ページです。 BehaviorEditorPart コントロールへの宣言参照を含む子<zonetemplate>要素を含む、EditorZone コントロールへの宣言型参照が含まれています。 ページには Pubs データベースにバインドされたBulletedList コントロールも含まれていることに注意してください。このコントロールはWebPartZoneに存在するため、BehaviorEditorPart コントロールで編集できるWebPart コントロールとして機能できます。

<%@ Page Language="C#" %>
<%@ Register Src="~/displayModeMenuCS.ascx" 
  TagPrefix="uc1" 
  TagName="DisplayModeMenuCS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  protected void Page_Load(object sender, EventArgs e)
  {
    Button1.Visible = false;
    TextBox1.Visible = false;
    BulletedList1.DataBind();
  }

  // <snippet3>
  protected void Button1_Click(object sender, EventArgs e)
  {
    BehaviorEditorPart1.Title = Server.HtmlEncode(TextBox1.Text);
  }
  // </snippet3>

  // <snippet4>
  protected void BehaviorEditorPart1_PreRender(object sender, 
    EventArgs e)
  {
    Button1.Visible = true;
    TextBox1.Visible = true;
  }
  // </snippet4>
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="form1" runat="server">
    <!-- This example uses Microsoft SQL Server and connects    -->
    <!-- to the Pubs sample database. Use an ASP.NET expression -->
    <!-- like the one in the following control to retrieve the  -->
    <!-- connection string value from the Web.config file.      -->
    <asp:SqlDataSource ID="ds1" runat="server" 
      connectionString="<%$ ConnectionStrings:PubsConnection %>" 
      SelectCommand="Select au_id, au_lname, au_fname From Authors"/>
    <asp:WebPartManager ID="WebPartManager1" runat="server" />
    <uc1:DisplayModeMenuCS id="menu1" runat="server" />
    <asp:WebPartZone ID="WebPartZone1" runat="server" Width="150" 
      style="z-index: 100; left: 10px; position: absolute; top: 90px" >
      <ZoneTemplate>
        <asp:Panel ID="panel1" runat="server" ToolTip="Author List WebPart">
          <asp:Label ID="Label1" runat="server" 
            Text="Author Names" 
            Font-Bold="true" 
            Font-Size="120%"
            AssociatedControlID="BulletedList1"/>
          <asp:BulletedList ID="BulletedList1" runat="server" 
            DataSourceID="ds1" 
            DataTextField="au_lname" 
            DataValueField="au_id"/>
        </asp:Panel>
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:WebPartZone ID="WebPartZone2" runat="server" Width="150" 
      style="z-index: 101; left: 170px; position: absolute; top: 90px" />
    <asp:EditorZone ID="EditorZone1" runat="server" 
      style="z-index: 102; left: 340px; position: absolute; top: 90px" 
      Width="170px">
      <ZoneTemplate>
        <asp:BehaviorEditorPart ID="BehaviorEditorPart1" runat="server" 
          Title="My BehaviorEditorPart"  
          OnPreRender="BehaviorEditorPart1_PreRender" />
      </ZoneTemplate>
    </asp:EditorZone>
    <asp:Button ID="Button1" runat="server" Width="140" 
      Text="Update EditorPart Title" 
      style="left: 340px; position: absolute; top: 65px; z-index: 103;" 
      OnClick="Button1_Click" />
    <asp:TextBox ID="TextBox1" runat="server" 
      style="z-index: 105; left: 500px; position: absolute; top: 65px" />
  </form>
</body>
</html>

<%@ Page Language="VB" %>
<%@ Register Src="~/displayModeMenuVB.ascx" 
  TagPrefix="uc1" 
  TagName="DisplayModeMenuVB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Protected Sub Page_Load(ByVal sender As Object, _
    ByVal e As System.EventArgs)
    Button1.Visible = False
    TextBox1.Visible = False
    BulletedList1.DataBind()
  End Sub

  ' <snippet3>
  Protected Sub Button1_Click(ByVal sender As Object, _
    ByVal e As System.EventArgs)
    BehaviorEditorPart1.Title = Server.HtmlEncode(TextBox1.Text)
  End Sub
  ' </snippet3>

  ' <snippet4>
  Protected Sub BehaviorEditorPart1_PreRender(ByVal sender As Object, _
    ByVal e As System.EventArgs)
   
    Button1.Visible = True
    TextBox1.Visible = True
    
  End Sub
  ' </snippet4>
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="form1" runat="server">
    <!-- This example uses Microsoft SQL Server and connects    -->
    <!-- to the Pubs sample database. Use an ASP.NET expression -->
    <!-- like the one in the following control to retrieve the  -->
    <!-- connection string value from the Web.config file.      -->
    <asp:SqlDataSource ID="ds1" runat="server" 
      connectionString="<%$ ConnectionStrings:PubsConnection %>" 
      SelectCommand="Select au_id, au_lname, au_fname From Authors"/>
    <asp:WebPartManager ID="WebPartManager1" runat="server" />
    <uc1:DisplayModeMenuVB id="menu1" runat="server" />
    <asp:WebPartZone ID="WebPartZone1" runat="server" Width="150" 
      style="z-index: 100; left: 10px; position: absolute; top: 90px" >
      <ZoneTemplate>
        <asp:Panel ID="panel1" runat="server" ToolTip="Author List WebPart">
          <asp:Label ID="Label1" runat="server" 
            Text="Author Names" 
            Font-Bold="true" 
            Font-Size="120%"
            AssociatedControlID="BulletedList1"/>
          <asp:BulletedList ID="BulletedList1" runat="server" 
            DataSourceID="ds1" 
            DataTextField="au_lname" 
            DataValueField="au_id"/>
        </asp:Panel>
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:WebPartZone ID="WebPartZone2" runat="server" Width="150" 
      style="z-index: 101; left: 170px; position: absolute; top: 90px" />
    <asp:EditorZone ID="EditorZone1" runat="server" 
      style="z-index: 102; left: 340px; position: absolute; top: 90px" 
      Width="170px">
      <ZoneTemplate>
        <asp:BehaviorEditorPart ID="BehaviorEditorPart1" runat="server" 
          Title="My BehaviorEditorPart"  
          OnPreRender="BehaviorEditorPart1_PreRender" />
      </ZoneTemplate>
    </asp:EditorZone>
    <asp:Button ID="Button1" runat="server" Width="140" 
      Text="Update EditorPart Title" 
      style="left: 340px; position: absolute; top: 65px; z-index: 103;" 
      OnClick="Button1_Click" />
    <asp:TextBox ID="TextBox1" runat="server" 
      style="z-index: 105; left: 500px; position: absolute; top: 65px" />
  </form>
</body>
</html>

この例の 3 番目の部分は、Web.config ファイル内のエントリです。 ファイルの <webParts> セクションで次のようなエントリを作成して、承認されたユーザーまたは一連のユーザーが共有パーソナル化スコープにあるときに Web ページを編集できるようにする必要があります。 このエントリは重要な手順です。それ以外の場合、ページを編集モードに切り替えると、 BehaviorEditorPart コントロールは表示されません。

<webParts>

<personalization>

<authorization>

<allow users="User_account" roles="admin"

verbs="enterSharedScope"/>

</authorization>

</personalization>

</webParts>

ブラウザーでページを読み込むときに、最初に [表示モード] ドロップダウン リスト コントロールの [共有] オプションを選択できます。 次に、ドロップダウン リスト自体をクリックし、[ 編集モード ] を選択してページを編集モードに切り替えます。 Author List WebPart コントロールのタイトル バーにある動詞メニュー (下向き矢印) をクリックし、[編集] をクリックして編集を開始できます。 編集 UI が表示されると、 BehaviorEditorPart コントロールと、その上に配置されたボタンとテキスト ボックスが表示されます。 編集 UI で変更を加えて [ 適用 ] ボタンをクリックすると、[ 表示モード ] ドロップダウン リスト コントロールを使用して、ページを参照モードに戻し、編集の変更の効果をすべて確認できます。

注釈

BehaviorEditorPart クラスは、EditorPart クラスから派生したエディター コントロールであり、関連付けられているWebPartまたはGenericWebPart コントロールの動作に影響するプロパティを編集するために使用されます。

Web パーツ コントロール セットにツール指向ゾーンがあるのと同様に (詳細については、 ToolZone クラスの概要を参照)、ツール指向のパーツ コントロール (ツール パーツ) があり、各ツール パーツは特定の種類のツール ゾーンに存在する必要があります。 Web パーツ コントロール セットのツール パーツには、次の 2 つの特徴があります。

• これらは、エンド ユーザーが Web パーツ ページでコントロールをカスタマイズできるようにするヘルパー コントロールです。

• 特定の表示モードでのみ表示されます。

BehaviorEditorPart コントロールは、Web パーツ ページが編集モードで、特定のWebPart コントロールが編集用に選択されている場合にのみ表示されるツール パーツです。 BehaviorEditorPart コントロールは、他のすべてのEditorPart コントロールと同様に、EditorZone コントロールに存在します。

特定の条件下では、コントロールはページに表示されません。 編集中のWebPart コントロールのIsSharedプロパティ値がtrueされ、ページがユーザーパーソナル化スコープ (既定) にある場合、コントロールは表示されません。 このシナリオで BehaviorEditorPart コントロールを表示するには、通常、次の 2 つの手順に従う必要があります。

• 共有パーソナル化スコープ内の Web ページを編集する権限を付与するエントリを Web.config ファイルに追加します (つまり、ユーザーが行った変更は、アプリケーションのすべてのユーザーに表示されます)。

• ToggleScope メソッドを使用して、実行時にページをユーザー レベルから共有レベルのパーソナル化スコープにプログラムで変更します。

BehaviorEditorPart コントロールをページに表示する方法の例については、このトピックの「例」セクションを参照してください。 共有コントロールとパーソナル化スコープの詳細については、「 Web パーツのパーソナル化の概要」を参照してください。

BehaviorEditorPart クラスには、EditorPart クラスから継承してオーバーライドする重要なメソッドSyncChangesもあります。 このメソッドは、編集中の WebPart コントロールからプロパティ値を取得し、編集コントロールのフィールドに割り当てることが可能になるため、非常に重要です。

ほとんどの場合、BehaviorEditorPart コントロールは、<zonetemplate>要素内で<asp:behavioreditorpart>要素を宣言することによってページ永続化形式で使用する必要があります。この要素は、Web ページ上の<asp:editorzone>要素に含まれます。 BehaviorEditorPart コントロールを使用すると、エンド ユーザーは、WebPart コントロールの次の UI プロパティを編集できます。

• Description

• TitleUrl

• TitleIconImageUrl

• CatalogIconImageUrl

• HelpUrl

• HelpMode

• ImportErrorMessage

• ExportMode

• AuthorizationFilter

• AllowClose

• AllowConnect

• AllowEdit

• AllowHide

• AllowMinimize

• AllowZoneChange

WebPart コントロールの他のプロパティと動作を編集するには、Web パーツ コントロール セットに付属する他のEditorPart コントロールを使用できます。 これらのコントロールには、 LayoutEditorPart、 AppearanceEditorPart、および PropertyGridEditorPart コントロールが含まれます。 指定された EditorPart コントロールは、 WebPart コントロールを編集するために必要なほとんどの編集機能を提供する必要がありますが、 EditorPart クラスから継承してカスタム エディター コントロールを作成することもできます。 コード例については、 EditorPart クラスの概要を参照してください。

アクセシビリティ

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

こちらもご覧ください

• AppearanceEditorPart
• LayoutEditorPart
• PropertyGridEditorPart
• Web パーツのパーソナル化の概要
• ASP.NET Web パーツ コントロール