WebPartManager.ImportWebPart メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

WebPartManager.ImportWebPart メソッド

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

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

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

Visual Basic (宣言)

Public Overridable Function
 ImportWebPart ( _
    reader As XmlReader, _
    <OutAttribute> ByRef errorMessage As
 String _
) As WebPart

Visual Basic (使用法)

Dim instance As WebPartManager
Dim reader As XmlReader
Dim errorMessage As String
Dim returnValue As WebPart

returnValue = instance.ImportWebPart(reader, errorMessage)

public virtual WebPart ImportWebPart (
    XmlReader reader,
    out string errorMessage
)

C++

public:
virtual WebPart^ ImportWebPart (
    XmlReader^ reader, 
    [OutAttribute] String^% errorMessage
)

public WebPart ImportWebPart (
    XmlReader reader, 
    /** @attribute OutAttribute() */ /** @ref */ String errorMessage
)

JScript

JScript では、値型の引数は参照渡しされません。

パラメータ

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

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

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

例外

例外の種類	条件
ArgumentNullException	reader が null 参照 (Visual Basic では Nothing) です。
EndOfStreamException	reader はこのファイルを読み取ることができませんでした。または reader は、インポートエラーメッセージを表示する必要がありましたが、ファイル内にそれが見つかりませんでした。または reader はファイルの末尾に到達しましたが、エクスポートデータが格納された XML 要素が見つかりませんでした。

例外の種類

条件

ArgumentNullException

reader が null 参照 (Visual Basic では Nothing) です。

EndOfStreamException

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

または

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

または

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

解説

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

コントロールのインポートを有効にするには、インポートが有効になるページに対し、開発者が CatalogZone コントロールを追加する必要があります。このゾーン内に、ImportCatalogPart コントロールを追加する必要があります。このコントロールは、インポートする記述ファイルをユーザーが参照して見つけることができる、ファイルダイアログボックスを提供します。

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

重要 :
ExportWebPart メソッドと同様に、ImportWebPart メソッドでも何らかのセキュリティリスクが発生する可能性があります。これは Web サイトへのデータのインポートに関係するため、悪意のあるユーザーはインポート元の記述ファイルへの不正なデータやスクリプトコードの挿入を試みることが可能です。そして、不正なデータをページ上やデータベースに表示したり、挿入したスクリプトを実行したりできます。記述ファイルのインポートに関連するリスクの可能性の概要については、「Web パーツページの保護」を参照してください。

重要 :