Language

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

定義

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 。

返品

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

例外

reader は nullです。

reader ファイルを読み取れませんでした。

-又は-

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

-又は-

reader は、エクスポートされたデータを含む XML 要素を見つけずにファイルの末尾に到達しました。

注釈

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

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

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

Important

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

適用対象

こちらもご覧ください