BehaviorEditorPart イベント
パブリック イベント| 名前 | 説明 | |
|---|---|---|
.gif) | DataBinding | サーバー コントロールがデータ ソースに連結すると発生します。 ( Control から継承されます。) |
| | Disposed | サーバー コントロールがメモリから解放されると発生します。これは、ASP.NET ページが要求されている場合のサーバー コントロールの有効期間における最終段階です。 ( Control から継承されます。) |
| | Init | サーバー コントロールが初期化されると発生します。これは、サーバー コントロールの有効期間における最初の手順です。 ( Control から継承されます。) |
| | Load | サーバー コントロールが Page オブジェクトに読み込まれると発生します。 ( Control から継承されます。) |
| | PreRender | Control オブジェクトの読み込み後、表示を開始する前に発生します。 ( Control から継承されます。) |
| | Unload | サーバー コントロールがメモリからアンロードされると発生します。 ( Control から継承されます。) |
参照BehaviorEditorPart クラス
アセンブリ: System.Web (system.web.dll 内)
構文解説BehaviorEditorPart クラスは、EditorPart クラスから派生するエディタ コントロールであり、関連付けられた WebPart コントロールまたは GenericWebPart コントロールの動作に影響するプロパティの編集に使用されます。
Web パーツ コントロール セット (詳細については ToolZone クラスの概要を参照) 内にツール指向のゾーンがあるように、ツール指向のパーツ コントロール (ツール パーツ) があり、各ツール パーツは特定のタイプのツール ゾーンに配置する必要があります。Web パーツ コントロール セットのツール パーツには、2 つの際立った特性があります。
BehaviorEditorPart コントロールは、Web パーツ ページが編集モードの場合、および編集のために特定の WebPart コントロールが選択されている場合にのみ表示されるツール パーツです。BehaviorEditorPart コントロールは、他のすべての EditorPart コントロールと同じように、EditorZone コントロールに配置されます。
.gif) 重要 : |
|---|
| EditorZone ゾーンには、EditorPart コントロールだけを格納できます。EditorPart コントロールを他のタイプのゾーンに配置することはできません。 |
コントロールは、特定の状況のページには表示されません。編集中の WebPart コントロールの IsShared プロパティ値が true であり、ページがユーザー パーソナル化スコープ (既定) にある場合、コントロールは表示されません。この場合に BehaviorEditorPart コントロールを表示するには、通常 2 つの手順に従う必要があります。
-
共有パーソナル化スコープの Web ページを編集するための、承認されているユーザー アクセス許可を与えるエントリを Web.config ファイルに追加します (つまり、ユーザーによる変更がアプリケーションのすべてのユーザーに表示されます)。
-
たとえば、ToggleScope メソッドを使用して、実行時にページのパーソナル化スコープをユーザー レベルから共有レベルにプログラムによって変更します。
BehaviorEditorPart コントロールをページに表示できるようにする方法の例については、このトピックの「使用例」セクションを参照してください。共有コントロールおよびパーソナル化スコープの詳細については、「Web パーツのパーソナル化の概要」を参照してください。
BehaviorEditorPart クラスには、SyncChanges という重要なメソッドもあります。これは、EditorPart クラスおよびオーバーライドから継承されます。このメソッドが重要なのは、編集中の WebPart コントロールからプロパティ値を取得してそれを編集中のコントロールのフィールドに代入できるからです。
ほとんどの場合、BehaviorEditorPart コントロールをページ内で永続形式で使用する必要があります。このためには、<asp:behavioreditorpart> 要素を <zonetemplate> 要素内で宣言します。この要素は Web ページ上の <asp:editorzone> 要素によって格納されます。BehaviorEditorPart コントロールを使用して、エンド ユーザーは、次に示す WebPart コントロールの UI プロパティを編集できます。
-
TitleUrl
-
TitleIconImageUrl
-
CatalogIconImageUrl
-
HelpUrl
-
HelpMode
-
ImportErrorMessage
-
ExportMode
-
AuthorizationFilter
-
AllowClose
-
AllowConnect
-
AllowEdit
-
AllowHide
-
AllowMinimize
-
AllowZoneChange
WebPart コントロールのプロパティおよび動作を編集するために、Web パーツ コントロール セットで提供される他の EditorPart コントロールを使用できます。これらのコントロールには、LayoutEditorPart、AppearanceEditorPart、PropertyGridEditorPart などのコントロールがあります。提供されている EditorPart コントロールでは、WebPart コントロールの編集に必要な編集機能のほとんどが提供されますが、EditorPart クラスから継承する方法でカスタムのエディタ コントロールを作成することもできます。コード例については、EditorPart クラスの概要を参照してください。
| メモ |
|---|
| ユーザー補助を向上させるには、BehaviorEditorPart コントロールを <fieldset> 要素内に表示します。<fieldset> 要素は、BehaviorEditorPart コントロール内で編集に使用される関連コントロール セットをグループ化します。ビジュアル ユーザー エージェント (通常の Web ブラウザなど) および音声指向ユーザー エージェント (画面読み取りソフトウェアなど) の両方で、それらのグループ化されたコントロール間をタブで簡単に移動できます。 |
ユーザー補助
使用例Web ページ内で BehaviorEditorPart コントロールを宣言し、それによって WebPart コントロールの複数の UI プロパティを編集できるようにする方法を次のコード例に示します。コード例は、次の 4 つの部分から成ります。
-
EditorZone コントロールおよび BehaviorEditorPart コントロールを含む Web ページ。BulletedList コントロールの動作プロパティの編集に使用されます。
-
共有パーソナル化スコープ内のページを編集するための、承認されたユーザー アクセス許可を付与するために Web.config ファイル内に作成するエントリ。
コード例の最初の部分は、Web ページ上の表示モードをユーザーが変更できるようにするユーザー コントロールです。表示モードの詳細、およびこのコントロールのソース コードの説明については、「チュートリアル : Web パーツ ページでの表示モードの変更」を参照してください。このユーザー コントロールのドキュメントには、ToggleScope メソッドを呼び出して、ページを BehaviorEditorPart コントロールを表示できる共有モードに切り替える方法が説明されています。
<%@ 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=" Display Mode" Font-Bold="true" Font-Size="8" Width="120" /> <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="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=" Display Mode" Font-Bold="true" Font-Size="8" Width="120" /> <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 ページです。ここには、EditorZone コントロールへの宣言参照、および子の <zonetemplate> 要素が含まれます。この子要素には BehaviorEditorPart コントロールへの宣言参照が含まれています。ページには、Pubs データベースにバインドされた BulletedList コントロールも含まれています。このコントロールは WebPartZone に配置されているので、BehaviorEditorPart コントロールで編集できる WebPart コントロールとして機能できます。
<%@ Page Language="VB" %> <%@ Register Src="~/displayModeMenuVB.ascx" TagPrefix="uc1" TagName="DisplayModeMenuVB" %> <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 Protected Sub Button1_Click(ByVal sender As Object, _ ByVal e As System.EventArgs) BehaviorEditorPart1.Title = Server.HtmlEncode(TextBox1.Text) End Sub Protected Sub BehaviorEditorPart1_PreRender(ByVal sender As Object, _ ByVal e As System.EventArgs) Button1.Visible = True TextBox1.Visible = True End Sub </script> <html > <head runat="server"> </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" Title="Author List WebPart"> <asp:Label ID="Label1" runat="server" Text="Author Names" Font-Bold="true" Font-Size="120%"/> <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="C#" %> <%@ Register Src="~/displayModeMenuCS.ascx" TagPrefix="uc1" TagName="DisplayModeMenuCS" %> <script runat="server"> protected void Page_Load(object sender, EventArgs e) { Button1.Visible = false; TextBox1.Visible = false; BulletedList1.DataBind(); } protected void Button1_Click(object sender, EventArgs e) { BehaviorEditorPart1.Title = Server.HtmlEncode(TextBox1.Text); } protected void BehaviorEditorPart1_PreRender(object sender, EventArgs e) { Button1.Visible = true; TextBox1.Visible = true; } </script> <html > <head runat="server"> </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" Title="Author List WebPart"> <asp:Label ID="Label1" runat="server" Text="Author Names" Font-Bold="true" Font-Size="120%"/> <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>
<allow users="User_account" roles="admin"
verbs="enterSharedScope"/>
</authorization>
</personalization>
</webParts>
ブラウザにページを読み込む場合は、まず [Display Mode] ドロップダウン リスト コントロールの [共有] オプションを選択できます。次に、ドロップダウン リスト自体をクリックし、[編集モード] を選択して、ページを編集モードに切り替えます。Author List WebPart コントロールのタイトル バーで動詞メニュー (下向きの矢印) をクリックし、[編集] をクリックすることにより、コントロールを編集できます。編集中の UI が表示状態の場合、BehaviorEditorPart コントロールが表示され、ボタンおよびテキスト ボックスがその上に配置されます。編集中の UI で変更を行い、[適用] ボタンをクリックした場合、[Display Mode] ドロップダウン リスト コントロールを使用して、ページをブラウズ モードに戻し、編集中の変更をすべて反映した結果を表示できます。
.NET Framework のセキュリティ継承階層System.Web.UI.Control
System.Web.UI.WebControls.WebControl
System.Web.UI.WebControls.Panel
System.Web.UI.WebControls.WebParts.Part
System.Web.UI.WebControls.WebParts.EditorPart
System.Web.UI.WebControls.WebParts.BehaviorEditorPart
スレッド セーフプラットフォームWindows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照BehaviorEditorPart コンストラクタ
アセンブリ: System.Web (system.web.dll 内)
構文解説BehaviorEditorPart コンストラクタは既定です。BehaviorEditorPart クラスで宣言されるコンストラクタは存在しないため、クラスの新しいインスタンスを作成する場合に特別な作業は不要です。
通常、コンストラクタを使用する必要はありません。これは、デザイン時の宣言で BehaviorEditorPart コントロールをページに追加できるからです。ただし、何らかの理由で BehaviorEditorPart コントロールをプログラムによって追加する必要がある場合は、BehaviorEditorPart コンストラクタを使用できます。
プラットフォームWindows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照BehaviorEditorPart プロパティ
パブリック プロパティ.gif)
参照BehaviorEditorPart メソッド
パブリック メソッド.gif)
.gif)
プロテクト メソッド| 名前 | 説明 | |
|---|---|---|
.gif) | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。) |
| | MemberwiseClone | 現在の Object の簡易コピーを作成します。 ( Object から継承されます。) |
参照BehaviorEditorPart メンバ
関連付けられた WebPart コントロールで複数のユーザー インターフェイス (UI) プロパティをエンド ユーザーが編集できるようにするエディタ コントロールを提供します。このクラスは継承できません。
BehaviorEditorPart データ型で公開されるメンバを以下の表に示します。
パブリック コンストラクタパブリック プロパティパブリック メソッドプロテクト メソッド| 名前 | 説明 | |
|---|---|---|
| | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。) |
| | MemberwiseClone | 現在の Object の簡易コピーを作成します。 (Object から継承されます。) |
パブリック イベント| 名前 | 説明 | |
|---|---|---|
| | DataBinding | サーバー コントロールがデータ ソースに連結すると発生します。(Control から継承されます。) |
| | Disposed | サーバー コントロールがメモリから解放されると発生します。これは、ASP.NET ページが要求されている場合のサーバー コントロールの有効期間における最終段階です。(Control から継承されます。) |
| | Init | サーバー コントロールが初期化されると発生します。これは、サーバー コントロールの有効期間における最初の手順です。(Control から継承されます。) |
| | Load | サーバー コントロールが Page オブジェクトに読み込まれると発生します。(Control から継承されます。) |
| | PreRender | Control オブジェクトの読み込み後、表示を開始する前に発生します。(Control から継承されます。) |
| | Unload | サーバー コントロールがメモリからアンロードされると発生します。(Control から継承されます。) |
参照- BehaviorEditorPartのページへのリンク
