EditorZoneBase.EditorParts プロパティ

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

EditorZoneBase.EditorParts プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

EditorZoneBase ゾーンに含まれるすべての EditorPart コントロールのコレクションを取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 EditorParts As EditorPartCollection

Visual Basic (使用法)

Dim instance As EditorZoneBase
Dim value As EditorPartCollection

value = instance.EditorParts

C#

public EditorPartCollection EditorParts { get;
 }

C++

public:
property EditorPartCollection^ EditorParts {
    EditorPartCollection^ get ();
}

J#

/** @property */
public EditorPartCollection get_EditorParts ()

JScript

public function get EditorParts
 () : EditorPartCollection

プロパティ値
ゾーン内の個別の EditorPart コントロールすべてを含む EditorPartCollection。

例外

例外の種類	条件
InvalidOperationException	コレクションに追加される EditorPart の ID プロパティに値が割り当てられていません。

解説

EditorParts プロパティは、ゾーンのすべての EditorPart コントロールのコレクションへの参照を提供します。このプロパティは、Web パーツ コントロール セットで提供される EditorPart コントロール、およびゾーンに追加される任意のカスタム EditorPart コントロールの両方を参照します。コレクションは読み取り専用であるため、汎用編集目的のカスタム EditorPart コントロールを作成し、それらをコレクションに追加する場合、その開発者が CreateEditorParts メソッドをオーバーライドする必要があります。

カスタム EditorPart コントロールをデザインして特定の WebPart コントロールを編集する場合、WebPart コントロール内で IWebEditable インターフェイスのメンバ (CreateEditorParts メソッドおよび WebBrowsableObject プロパティ) をオーバーライドする必要があります。これらのメンバをオーバーライドする理由は、コントロールが編集中の場合に、WebPart コントロールがカスタム EditorPart コントロールを作成してそれらを EditorParts コレクションに追加できるようにするためです。また、編集中の WebPart コントロールへのオブジェクト参照で編集コントロールを提供するためでもあります。カスタム EditorPart コントロールを追加して、WebPart クラスから継承していないサーバー コントロールを編集する場合は、WebPart の場合とまったく同様に、IWebEditable インターフェイスをそのクラスで実装する必要があります。

メモ
CreateEditorParts メソッドの実装で EditorPart コントロールのコレクションに追加される EditorPart の ID プロパティには値を割り当てておく必要があります。これを行わないと、コレクションを EditorParts プロパティに代入したときに例外がスローされます。

使用例

EditorParts プロパティへのプログラムを使用したアクセス方法を次のコード例に示します。例の実行に必要なコード全体については、EditorZoneBase クラスの概要のトピックで「例」を参照してください。

コード例の最初の部分は、Web ページで宣言を使用して参照されるすべての EditorPart コントロールへの参照を含んでいる EditorParts プロパティです。

Visual Basic

<aspSample:MyEditorZone ID="EditorZone1" runat="server">
  <ApplyVerb Text="Apply Changes" />
  <CancelVerb Text="Cancel Changes" />
  <OKVerb Text="Finished" />
  <ZoneTemplate>
    <asp:AppearanceEditorPart ID="AppearanceEditorPart1"
 
      runat="server" />
    <asp:LayoutEditorPart ID="LayoutEditorPart1"
 
      runat="server" />
  </ZoneTemplate>
</aspSample:MyEditorZone>

C#

<aspSample:MyEditorZone ID="EditorZone1" runat="server">
  <ApplyVerb Text="Apply Changes" />
  <CancelVerb Text="Cancel Changes" />
  <OKVerb Text="Finished" />
  <ZoneTemplate>
    <asp:AppearanceEditorPart ID="AppearanceEditorPart1" 
      runat="server" />
    <asp:LayoutEditorPart ID="LayoutEditorPart1" 
      runat="server" />
  </ZoneTemplate>
</aspSample:MyEditorZone>

コード例の 2 番目の部分は、プログラムを使用した EditorParts プロパティへのアクセスおよび Label コントロール内の各コントロールの ID の一覧表示です。

Visual Basic

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

C#

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

ブラウザでページを読み込む場合、[Display EditorParts Collection] ボタンをクリックして、EditorParts プロパティで参照されるすべての EditorPart コントロールの ID を一覧表示できます。

プラットフォーム

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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
EditorZoneBase クラス
EditorZoneBase メンバ
System.Web.UI.WebControls.WebParts 名前空間
IWebEditable
CreateEditorParts
CreateEditorParts
その他の技術情報
ASP.NET Web パーツ ページ