WebPartManager.CopyWebPart メソッド

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

WebPartManager.CopyWebPart メソッド

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

Web ページに WebPart コントロールまたはサーバー コントロールを追加するためにこうしたコントロールのコピーを作成する場合に、Web パーツ コントロール セットで使用されます。

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

Visual Basic (宣言)

Protected Overridable Function
 CopyWebPart ( _
    webPart As WebPart _
) As WebPart

Visual Basic (使用法)

Dim webPart As WebPart
Dim returnValue As WebPart

returnValue = Me.CopyWebPart(webPart)

C#

protected virtual WebPart CopyWebPart (
    WebPart webPart
)

C++

protected:
virtual WebPart^ CopyWebPart (
    WebPart^ webPart
)

J#

protected WebPart CopyWebPart (
    WebPart webPart
)

JScript

protected function CopyWebPart (
    webPart : WebPart
) : WebPart

パラメータ

webPart

コピー対象の WebPart コントロールまたはサーバー コントロール。

戻り値
ページに追加される WebPart。

解説

CopyWebPart メソッドを、コードから直接呼び出すことはできません。このメソッドは、新しい動的な WebPart コントロールまたはサーバー コントロールをページに追加するプロセスの一部として、WebPartManager コントロールによって内部的に呼び出されます。ダイナミック コントロールは、プログラムでページに追加するか、または Web パーツ ユーザー インターフェイス (UI) を通じて、たとえば、ユーザーがコントロールのカタログから追加します。対照的に、スタティック コントロールは、ページのマークアップに直接宣言します。

メモ
開発者がこのメソッドで追加のコントロールのコピー操作を処理できるようにする場合は、派生クラスでこのメソッドをオーバーライドできます。詳細については、「継承時の注意」を参照してください。

新しいダイナミック コントロールを追加するときに、それが WebPart コントロールの場合、CopyWebPart メソッドがそのコントロールの新しいインスタンスを返します。追加するコントロールがその他の種類のサーバー コントロールの場合 (ユーザー コントロール、カスタム コントロール、ASP.NET コントロールなど)、そのコントロールは、Web パーツ コントロール セットによって既に GenericWebPart オブジェクトでラップされています。CopyWebPart メソッドが GenericWebPart コントロールを検出すると、子コントロールの新しいインスタンスがその内部にラップされた、GenericWebPart コントロールの新しいインスタンスを返します。

CopyWebPart メソッドは、返すコントロールの新しいコピーを作成すると、すべてのプロパティの値も既定値にリセットします。パーソナル化できるプロパティの値を保存し、これらを新しいコントロール インスタンスにコピーする場合は、CopyPersonalizationState メソッドも呼び出す必要があります。CopyWebPart メソッドが実行する最後の手順では、CreateDynamicWebPartID メソッドを呼び出してコントロールの新しい ID を取得します。

メモ
このメソッドは、コピーしたコントロールの新しい ID を取得します。したがって、その元の ID でページに追加されるダイナミック コントロールへの参照を使用しないでください。代わりに、このメソッドで返されるこのコントロールの新しいインスタンスを参照する必要があります。

継承時の注意 このメソッドは、virtual として宣言されます。このため、開発者は、WebPartManager クラスから継承し、このメソッドをオーバーライドすることにより、コントロールのコピーを作成できる追加のシナリオを用意できます。たとえば、このメソッドはオプションで、XML ファイルにシリアル化されたコントロールを入力として受け取ることができます。このメソッドは、XML (存在する場合) を逆シリアル化し、基本メソッドを呼び出して既存の状態を処理し、WebPart コントロールの新しいインスタンスを返すことができます。

プラットフォーム

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

参照

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