AppearanceEditorPart クラス
アセンブリ: System.Web (system.web.dll 内)
構文解説AppearanceEditorPart クラスは、EditorPart クラスから派生したエディタ コントロールで、関連付けられた WebPart の外観や他のサーバー コントロールの外観に関連するプロパティを編集するために使用されます。
AppearanceEditorPart コントロールによって、エンド ユーザーが WebPart コントロールの複数の UI プロパティを編集できるようになります。各プロパティの値を編集するためにページに表示されるコントロールの型の一覧を、次の表に示します。
| ChromeType | |
| TextBox コントロールは、高さの値を設定するために使用され、DropDownList コントロールは、単位を選択するために使用されます。 | |
| TextBox コントロールは、高さの値を設定するために使用され、DropDownList コントロールは、単位を選択するために使用されます。 | |
AppearanceEditorPart コントロールは、Web パーツ ページが編集モードで、特定の WebPart コントロールが編集対象として選択されている場合にだけ表示されるようになります。AppearanceEditorPart コントロールは、他のすべての EditorPart コントロールと同様に特定の EditorZone ゾーンに配置されます。
AppearanceEditorPart クラスには、最小限のプロパティのセットがあります。Title プロパティは、コントロールが表示されている場合にタイトルとして表示される文字列を取得または設定するために使用されます。DefaultButton プロパティには Panel コントロールから継承したプロパティが設定されるため、AppearanceEditorPart コントロールで既定のフォーカスが設定されるコントロールは、基本 Panel コントロールの既定と同じになります。
また、AppearanceEditorPart クラスには、2 つの重要なメソッドが存在します。SyncChanges メソッドは、EditorPart クラスの基本メソッドをオーバーライドします。このメソッドは、プロパティ値を編集したりエディタ コントロールのフィールドに割り当てたりしている WebPart コントロールからプロパティ値を取得できるようになるため、重要です。また、ApplyChanges メソッドも、ユーザーが編集コントロールで設定した値を受け取り、編集中のコントロールでそれらのプロパティ値を更新するため、重要です。
AppearanceEditorPart コントロールは、ほとんどの場合、Web ページ上の <asp:editorzone> 要素に含まれる <zonetemplate> 要素内に <asp:appearanceditorpart> 要素を宣言することにより、ページの永続化形式で使用する必要があります。
他のプロパティおよび WebPart コントロールの動作を編集するには、Web パーツ コントロール セットで提供される他の EditorPart コントロールを使用できます。これらのコントロールには、BehaviorEditorPart、LayoutEditorPart、および PropertyGridEditorPart が含まれます。提供される EditorPart コントロールによって、WebPart コントロールを編集するために必要なほとんどの編集機能が提供されますが、EditorPart クラスを継承してカスタムのエディタ コントロールを作成することもできます。コード例については、EditorPart クラスの概要のトピックを参照してください。
.gif) メモ |
|---|
| ユーザーの操作性を向上するために、<fieldset> 要素内に AppearanceEditorPart コントロールが出力されます。<fieldset> 要素は、AppearanceEditorPart コントロールで編集のために使用される、関連のあるコントロールのセットをグループ化します。これによって、ビジュアル系のユーザー エージェント (一般の Web ブラウザなど) や音声処理系のユーザー エージェント (画面読み上げソフトウェアなど) の両方で、これらのコントロール間をタブにより簡単に移動できるようになります。 |
ユーザー補助
使用例Web ページ上に AppearanceEditorPart コントロールを宣言し、そのコントロールによって WebPart コントロールのいくつかの UI のプロパティを編集できるようにする方法を、次のコード例に示します。コード例は、次の 4 つの部分から成ります。
ユーザー コントロールのソース コードは、別のトピックのものを使用しています。このコード例を実行するには、チュートリアル : Web パーツ ページでの表示モードの変更 のトピックに記載されているユーザー コントロールの .ascx ファイルを、このコード例に示されている .ascx ページと同じフォルダに配置する必要があります。
コード例の 2 番目の部分は Web ページです。ここには、EditorZone コントロールへの宣言的な参照と共に、AppearanceEditorPart コントロールへの宣言的な参照を含む子 <zonetemplate> 要素が含まれます。またこのページは、アセンブリの Register ディレクティブとコントロールの <aspSample:TextDisplayWebPart> 要素を使用して、カスタムの WebPart コントロールを参照します。
<%@ page language="vb" %> <%@ register TagPrefix="uc1" TagName="DisplayModeMenu" Src="DisplayModevb.ascx" %> <%@ register tagprefix="aspSample" Namespace="Samples.AspNet.VB.Controls" Assembly="TextDisplayWebPartVB" %> <html> <head id="Head1" runat="server"> <title> Text Display WebPart with AppearanceEditorPart </title> </head> <body> <form id="form1" runat="server"> <asp:webpartmanager id="WebPartManager1" runat="server" /> <uc1:DisplayModeMenu ID="DisplayModeMenu1" runat="server" /> <asp:webpartzone id="zone1" runat="server"> <zonetemplate> <aspSample:TextDisplayWebPart runat="server" id="textwebpart" title = "Text Content WebPart" /> </zonetemplate> </asp:webpartzone> <asp:EditorZone ID="EditorZone1" runat="server"> <ZoneTemplate> <asp:AppearanceEditorPart ID="AppearanceEditorPart1" runat="server" Title="Edit TextDisplayWebPart Properties" /> </ZoneTemplate> </asp:EditorZone> </form> </body> </html>
<%@ page language="c#" %> <%@ register TagPrefix="uc1" TagName="DisplayModeMenu" Src="DisplayModecs.ascx" %> <%@ register tagprefix="aspSample" Namespace="Samples.AspNet.CS.Controls" Assembly="TextDisplayWebPartCS" %> <html> <head id="Head1" runat="server"> <title> Text Display WebPart with AppearanceEditorPart </title> </head> <body> <form id="form1" runat="server"> <asp:webpartmanager id="WebPartManager1" runat="server" /> <uc1:DisplayModeMenu ID="DisplayModeMenu1" runat="server" /> <asp:webpartzone id="zone1" runat="server"> <zonetemplate> <aspSample:TextDisplayWebPart runat="server" id="textwebpart" title = "Text Content WebPart" /> </zonetemplate> </asp:webpartzone> <asp:EditorZone ID="EditorZone1" runat="server"> <ZoneTemplate> <asp:AppearanceEditorPart ID="AppearanceEditorPart1" runat="server" Title="Edit TextDisplayWebPart Properties" /> </ZoneTemplate> </asp:EditorZone> </form> </body> </html>
コード例の 3 番目の部分は、Web ページで参照される TextDisplayWebPart という名前のカスタム WebPart クラスです。コード例を実行するためには、このソース コードをコンパイルする必要があります。それを明示的にコンパイルし、コンパイル済みのアセンブリを Web サイトの Bin フォルダまたはグローバル アセンブリ キャッシュに配置できます。サイトの App_Code フォルダにソース コードを配置し、実行時に動的にコンパイルすることもできます。コンパイル方法を示すチュートリアルについては、「チュートリアル : カスタム サーバー コントロールの開発と使用」を参照してください。
Imports System Imports System.Collections Imports System.ComponentModel Imports System.Drawing Imports System.Security.Permissions Imports System.Web Imports System.Web.UI 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 TextDisplayWebPart Inherits WebPart Private _contentText As String = Nothing Private _fontStyle As String = Nothing Private input As TextBox Private DisplayContent As Label Private lineBreak As Literal <Personalizable(), WebBrowsable()> _ Public Property ContentText() As String Get Return _contentText End Get Set(ByVal value As String) _contentText = value End Set End Property Protected Overrides Sub CreateChildControls() Controls.Clear() DisplayContent = New Label() DisplayContent.BackColor = Color.LightBlue DisplayContent.Text = Me.ContentText Me.Controls.Add(DisplayContent) lineBreak = New Literal() lineBreak.Text = "<br />" Controls.Add(lineBreak) input = New TextBox() Me.Controls.Add(input) Dim update As New Button() update.Text = "Set Label Content" AddHandler update.Click, AddressOf Me.submit_Click Me.Controls.Add(update) End Sub Private Sub submit_Click(ByVal sender As Object, _ ByVal e As EventArgs) ' Update the label string. If input.Text <> String.Empty Then _contentText = input.Text + "<br />" input.Text = String.Empty DisplayContent.Text = Me.ContentText End If End Sub End Class End Namespace
using System; using System.Collections; using System.ComponentModel; using System.Drawing; using System.Security.Permissions; using System.Web; using System.Web.UI; 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 TextDisplayWebPart : WebPart { private String _contentText = null; TextBox input; Label DisplayContent; Literal lineBreak; [Personalizable(), WebBrowsable] public String ContentText { get { return _contentText; } set { _contentText = value; } } protected override void CreateChildControls() { Controls.Clear(); DisplayContent = new Label(); DisplayContent.BackColor = Color.LightBlue; DisplayContent.Text = this.ContentText; this.Controls.Add(DisplayContent); lineBreak = new Literal(); lineBreak.Text = @"<br />"; Controls.Add(lineBreak); input = new TextBox(); this.Controls.Add(input); Button update = new Button(); update.Text = "Set Label Content"; update.Click += new EventHandler(this.submit_Click); this.Controls.Add(update); } private void submit_Click(object sender, EventArgs e) { // Update the label string. if (input.Text != String.Empty) { _contentText = input.Text + @"<br />"; input.Text = String.Empty; DisplayContent.Text = this.ContentText; } } } }
ブラウザでページを読み込む場合、[Display Mode] ドロップダウン リスト コントロールで [編集モード] を選択して、編集モードに切り替えることができます。TextDisplayWebPart コントロールのタイトル バーで動詞メニュー (下向きの矢印) をクリックし、[編集] をクリックすることにより、コントロールを編集できます。編集 UI が表示状態の場合、AppearanceEditorPart コントロールが表示されます。編集 UI で変更を行って [Apply] ボタンをクリックした場合、[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.AppearanceEditorPart
スレッド セーフプラットフォーム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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照- AppearanceEditorPart クラスのページへのリンク
