WebPartManager.ExportWebPart メソッド

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

WebPartManager.ExportWebPart メソッド

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

サーバー コントロールの状態データとプロパティ データが格納された XML 記述ファイルを作成します。

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

Visual Basic (宣言)

Public Overridable Sub ExportWebPart
 ( _
    webPart As WebPart, _
    writer As XmlWriter _
)

Visual Basic (使用法)

Dim instance As WebPartManager
Dim webPart As WebPart
Dim writer As XmlWriter

instance.ExportWebPart(webPart, writer)

C#

public virtual void ExportWebPart (
    WebPart webPart,
    XmlWriter writer
)

C++

public:
virtual void ExportWebPart (
    WebPart^ webPart, 
    XmlWriter^ writer
)

J#

public void ExportWebPart (
    WebPart webPart, 
    XmlWriter writer
)

JScript

public function ExportWebPart (
    webPart : WebPart, 
    writer : XmlWriter
)

パラメータ

webPart

データのエクスポート元となるコントロール。

writer

エクスポートされたデータを webPart から XML 記述ファイルに書き込む XmlWriter。

例外

例外の種類	条件
ArgumentNullException	webPart が null 参照 (Visual Basic では Nothing) です。 または writer が null 参照 (Visual Basic では Nothing) です。
ArgumentException	webPart が、Controls で参照されるコントロールのコレクションに格納されていません。 または webPart の ExportMode プロパティが、None の値に設定されています。これは、webPart のエクスポートが無効になっていることを示します。

解説

ExportWebPart メソッドは、さまざまな状態データとプロパティ データを webPart から XML ファイルにアセンブルします。このデータには、アセンブリ、状態データ、プロパティ データを含め、コントロール自体に関する情報が格納されます。エクスポートを開始するユーザーは、ローカル コンピュータまたはネットワークのディスクに XML ファイルを保存できます。この後、その他のユーザーが、この記述ファイルを別のページまたは別の Web サイトにインポートし、状態データとプロパティ データを別の webPart のインスタンスに適用できます。これにより、ユーザーがサーバー コントロールの設定を共有および再利用したり、開発者がエクスポートおよびインポートしたコントロールの外観と動作を制御したりするための迅速で簡単なしくみが提供されます。

既定では、webPart のプロパティはエクスポートされません。プロパティのエクスポートを有効にするには、ソース コードの [Personalizable] 属性でプロパティをマークする必要があります。また、オプションで、[Personalizable] 属性の isSensitive パラメータを true に設定することにより、エクスポート可能なプロパティを重要情報が含まれているものとしてマークできます。既定では、isSensitive は false です。開発者は、このパラメータを true に設定し、そのデータが重要情報であることを示すことができます。

webPart をエクスポートできるようにするには、開発者は、その ExportMode プロパティ値を、All (パーソナル化できるプロパティと重要プロパティをすべてエクスポート) または NonSensitiveData (重要プロパティを除きすべてをエクスポート) のいずれかに設定します。

重要 :
ユーザーがコントロールからデータをエクスポートし、他のコントロールにデータをインポートできるようにすると、ある程度のセキュリティ リスクが発生します。開発者は、上で説明した方法を使用して重要情報を保護する必要があります。データ全体が公開される危険を防止する場合は、webPart のエクスポートを決して有効にしないでください。Web パーツのセキュリティ上の問題の詳細については、「Web パーツ ページの保護」を参照してください。

プラットフォーム

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 名前空間
WebPart.ExportMode プロパティ
ImportWebPart
その他の技術情報
Web パーツ ページの保護