WebPartManager.ImportWebPart(XmlReader, String) メソッド

  • リファレンス

定義

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

WebPart コントロールの状態データとプロパティ データが格納された XML 記述ファイルをインポートし、コントロールにそのデータを適用します。

public:
 virtual System::Web::UI::WebControls::WebParts::WebPart ^ ImportWebPart(System::Xml::XmlReader ^ reader, [Runtime::InteropServices::Out] System::String ^ % errorMessage);
public virtual System.Web.UI.WebControls.WebParts.WebPart ImportWebPart (System.Xml.XmlReader reader, out string errorMessage);
abstract member ImportWebPart : System.Xml.XmlReader * string -> System.Web.UI.WebControls.WebParts.WebPart
override this.ImportWebPart : System.Xml.XmlReader * string -> System.Web.UI.WebControls.WebParts.WebPart
Public Overridable Function ImportWebPart (reader As XmlReader, ByRef errorMessage As String) As WebPart

パラメーター

reader
XmlReader

インポート元となる XML 記述ファイルから状態データとプロパティ データを読み取る XmlReader。

errorMessage
String

インポート中にエラーが発生した場合にユーザーに表示される String。

戻り値

WebPart

インポート元となる XML 記述ファイルで参照される WebPart (または、GenericWebPart でラップされ、WebPart として扱われるサーバー コントロール)。

例外

ArgumentNullException

reader が nullです。

EndOfStreamException

reader はこのファイルを読み取ることができませんでした。

- または -

reader は、インポート エラー メッセージを表示する必要がありましたが、ファイル内にそれが見つかりませんでした。

- または -

reader はファイルの末尾に到達しましたが、エクスポート データが格納された XML 要素が見つかりませんでした。

注釈

メソッドは ImportWebPart 、サーバー コントロールの メソッドによって ExportWebPart 作成された XML 記述ファイルをインポートします。 インポートされるのは実際のサーバー コントロールではなく、コントロールに関する状態とプロパティ データを含む説明ファイルのみです。 説明ファイルで参照されるコントロールとアセンブリは、ユーザーが説明ファイルのインポートを試みるサーバーで既に使用できる必要があります。

コントロールのインポートを有効にするには、インポートが有効になるページにコントロールを追加 CatalogZone する必要があります。 ゾーン内では、コントロールを ImportCatalogPart 追加する必要があります。 このコントロールには、ユーザーがインポートする説明ファイルを参照して検索できるファイル ダイアログ ボックスが用意されています。

ユーザーが説明ファイルを見つけてインポートを開始すると、 メソッドによって ImportWebPart 説明ファイルが読み取られます。 エラーがなく、アセンブリとコントロールが見つかった場合は、サーバー コントロールがコントロール内 ImportCatalogPart のカタログに追加され、説明ファイルで指定されたさまざまなプロパティと状態データがコントロールに適用されます。 その後、ユーザーはコントロールを選択してページに追加できます。

重要

メソッドと同様にExportWebPartImportWebPart、 メソッドにはセキュリティ リスクの可能性があります。 Web サイトへのデータのインポートが含まれるため、悪意のあるユーザーが、インポートされた説明ファイルに不適切なデータやスクリプト コードを挿入しようとする可能性があります。 その後、不適切なデータがページまたはデータベースに表示されたり、挿入されたスクリプトが実行されたりする可能性があります。 説明ファイルのインポートに関連する潜在的なリスクの概要と、それらのリスクを回避する方法については、「 Web パーツ ページのセキュリティ保護」を参照してください。

適用対象

こちらもご覧ください