IWebEditable.CreateEditorParts メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

IWebEditable.CreateEditorParts メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

IWebEditable インターフェイスを実装するサーバーコントロールに関連付けられているカスタム EditorPart コントロールのコレクションを返します。

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

Visual Basic (宣言)

Function CreateEditorParts As EditorPartCollection

Visual Basic (使用法)

Dim instance As IWebEditable
Dim returnValue As EditorPartCollection

returnValue = instance.CreateEditorParts

EditorPartCollection CreateEditorParts ()

C++

EditorPartCollection^ CreateEditorParts ()

EditorPartCollection CreateEditorParts ()

JScript

function CreateEditorParts () : EditorPartCollection

戻り値
サーバーコントロールに関連付けられているカスタム EditorPart コントロールのコレクションを格納する EditorPartCollection。

解説

CreateEditorParts メソッドを使用すると、独自のカスタムコントロールに関連付けられているすべてのカスタム EditorPart コントロール、WebPart コントロール、またはユーザーコントロールのコレクションを作成し、それらを EditorPartCollection オブジェクトとして返すことができます。WebPartManager コントロールは、サーバーコントロールが編集モードになるたびに、コレクションを取得し、すべての EditorPart コントロールのインスタンスを作成します。

通常、このメソッドは、カスタム WebPart コントロールでその CreateEditorParts メソッドをオーバーライドすることで実装します。このメソッドでは、ユーザーのコントロールに関連付けるカスタム EditorPart コントロールのインスタンスを作成し、それらを EditorPartCollection オブジェクトに追加して、そのオブジェクトを返します。EditorPart コントロールのコレクションは、その後 EditorZoneBase ゾーンの EditorParts プロパティに代入されます。

メモ
CreateEditorParts メソッドの実装で EditorPart コントロールのコレクションに追加される EditorPart は、その ID プロパティに代入された値を保持する必要があります。そうしない場合、コレクションを EditorParts プロパティに代入すると例外がスローされます。

実装時の注意 CreateEditorParts メソッドが返す EditorPartCollection オブジェクトは読み取り専用で、そのオブジェクトにアクセスして個別のコントロールを追加するメソッドはありません。ただし、そのメソッドのオーバーライドまたは実装では、すべてのカスタム EditorPart コントロールを格納する ArrayList などの別の種類の ICollection オブジェクトを作成し、新しい EditorPartCollection オブジェクトを作成するときにそれをコンストラクタに渡すことができます。コード例については、「使用例」のセクションを参照してください。

使用例

カスタム WebPart コントロールでの CreateEditorParts メソッドのオーバーライドを次のコード例に示します。この例を実行するために必要な完全なソースコードは、IWebEditable クラスの概要トピックにある「例」のセクションを参照してください。

コード例には、IWebEditable インターフェイスの両方のメンバが含まれます。CreateEditorParts メソッドのオーバーライドは、ArrayList を作成して、1 つ以上のカスタム EditorPart コントロールを収集し、そのリストを使用して EditorPartCollection オブジェクトを作成します。

Visual Basic

Public Overrides Function
 CreateEditorParts() _
                            As EditorPartCollection
  Dim editorArray As New
 ArrayList()
  Dim edPart as New TextDisplayEditorPart()
  edPart.ID = Me.ID & "_editorPart1"
  editorArray.Add(edPart)
  Dim editorParts As New
 EditorPartCollection(editorArray)
  Return editorParts

End Function

Public Overrides ReadOnly
 Property WebBrowsableObject() _
                                    As Object
  Get
    Return Me
  End Get
End Property

public override EditorPartCollection CreateEditorParts()
{
  ArrayList editorArray = new ArrayList();
  TextDisplayEditorPart edPart = new TextDisplayEditorPart();
  edPart.ID = this.ID + "_editorPart1";
  editorArray.Add(edPart);
  EditorPartCollection editorParts = 
    new EditorPartCollection(editorArray);
  return editorParts;
}

public override object WebBrowsableObject
{
  get { return this; }
}