WebPartZone.GetInitialWebParts メソッド

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

WebPartZone.GetInitialWebParts メソッド

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

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

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

Visual Basic (宣言)

Protected Friend Overrides
 Function GetInitialWebParts As WebPartCollection

Visual Basic (使用法)

Dim returnValue As WebPartCollection

returnValue = Me.GetInitialWebParts

C#

protected internal override WebPartCollection GetInitialWebParts
 ()

C++

protected public:
virtual WebPartCollection^ GetInitialWebParts () override

J#

protected WebPartCollection GetInitialWebParts ()

JScript

protected internal override function
 GetInitialWebParts () : WebPartCollection

戻り値
ゾーンのテンプレート内に格納されているすべての WebPart または他のサーバー コントロールが含まれている WebPartCollection。

解説

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

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

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

メモ

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

プラットフォーム

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

参照

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