WebPartZone.GetInitialWebParts メソッド

定義

名前空間:
System.Web.UI.WebControls.WebParts
アセンブリ:
System.Web.dll

抽象基本メソッドをオーバーライドし、ゾーンのテンプレートに含まれる静的 WebPart コントロールの初期セットを取得します。

protected public:
 override System::Web::UI::WebControls::WebParts::WebPartCollection ^ GetInitialWebParts();
protected internal override System.Web.UI.WebControls.WebParts.WebPartCollection GetInitialWebParts();
override this.GetInitialWebParts : unit -> System.Web.UI.WebControls.WebParts.WebPartCollection
Protected Friend Overrides Function GetInitialWebParts () As WebPartCollection

返品

WebPartCollection

ゾーンのテンプレートに含まれるすべてのWebPartまたはその他のサーバー コントロールを含むWebPartCollection。

注釈

GetInitialWebParts メソッドは、抽象基本GetInitialWebParts メソッドの実装を提供します。 基本メソッドは実装を提供しませんが、派生クラスが、パーソナル化の変更を考慮せずに、ゾーンに属するコントロールの初期セットを取得する方法をカスタマイズできるように、メソッドを宣言します。

ゾーン内のサーバー コントロールごとに、 CreateWebPart メソッドが呼び出されます。 コントロールが WebPart クラスから直接継承される場合、そのコントロールはゾーンの WebParts コレクション (および WebPartManager コントロールの同様のコレクション) に追加されます。 コントロールが WebPartから直接継承されない場合、Web パーツ コントロール セットはコントロールを GenericWebPart オブジェクトでラップし、実行時にコントロールを WebPart コントロールとして動作できるようにします。

WebPartZone クラスは、Web パーツ ページのマークアップ内の一連の<zonetemplate> タグ内で静的に宣言されているコントロールのセット (存在する場合) を返すことによって、基本メソッドを実装します。 PlaceHolder コントロールがゾーンで宣言されている場合、コントロール自体ではなく、そのコントロールの子コントロールが追加されます。 この実装を使用すると、たとえば、マスター ページに WebPartZone ゾーンを作成し、コンテンツ ページで個々の WebPart またはサーバー コントロールを宣言できます。 WebPartZone ゾーンでLiteralコントロールを宣言した場合、コントロールは無視されます。

Note

GetInitialWebParts メソッドによって返されるコントロールの初期コレクションは、パーソナル化が行われた後、ゾーン内のコントロールの実際の実行時コレクションとは異なる場合があります。 たとえば、2 つのWebPartZone コントロールを含む Web ページがあり、最初のページには、<zonetemplate> タグ内で静的に宣言されたUser1という名前のユーザー コントロールが含まれているとします。 ユーザーがページを読み込み、 User1 を 2 番目のゾーンにドラッグした場合、 User1 は、そのゾーンで宣言されているため、最初のゾーンの GetInitialWebParts メソッドを呼び出すことによって返されるコレクションの一部です。 ただし、実行時に、 WebPartManager コントロールがパーソナル化データを読み込むと、 User1 ユーザーがドラッグした 2 番目のゾーンに実際に表示されます。

適用対象

こちらもご覧ください