WebPartManager.CreateErrorWebPart メソッド

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

WebPartManager.CreateErrorWebPart メソッド

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

動的な WebPart コントロールを読み込むか作成しようとして何らかの理由で失敗したときに、ページに挿入してエンド ユーザーに表示する特別なコントロールを作成します。

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

Visual Basic (宣言)

Protected Overridable Function
 CreateErrorWebPart ( _
    originalID As String, _
    originalTypeName As String, _
    originalPath As String, _
    genericWebPartID As String, _
    errorMessage As String _
) As ErrorWebPart

Visual Basic (使用法)

Dim originalID As String
Dim originalTypeName As String
Dim originalPath As String
Dim genericWebPartID As String
Dim errorMessage As String
Dim returnValue As ErrorWebPart

returnValue = Me.CreateErrorWebPart(originalID, originalTypeName,
 originalPath, genericWebPartID, errorMessage)

C#

protected virtual ErrorWebPart CreateErrorWebPart (
    string originalID,
    string originalTypeName,
    string originalPath,
    string genericWebPartID,
    string errorMessage
)

C++

protected:
virtual ErrorWebPart^ CreateErrorWebPart (
    String^ originalID, 
    String^ originalTypeName, 
    String^ originalPath, 
    String^ genericWebPartID, 
    String^ errorMessage
)

J#

protected ErrorWebPart CreateErrorWebPart (
    String originalID, 
    String originalTypeName, 
    String originalPath, 
    String genericWebPartID, 
    String errorMessage
)

JScript

protected function CreateErrorWebPart (
    originalID : String, 
    originalTypeName : String, 
    originalPath : String, 
    genericWebPartID : String, 
    errorMessage : String
) : ErrorWebPart

パラメータ

originalID

失敗するコントロールの ID を含む文字列。GenericWebPart がこの失敗に関係する場合、ID はその子サーバー コントロールの ID です。

originalTypeName

失敗したコントロールの Type の名前を表す文字列。GenericWebPart がこの失敗に関係する場合、型名はその子サーバー コントロールの型名です。

originalPath

子ユーザー コントロールを格納する GenericWebPart がこの失敗に関係する場合、ユーザー コントロールへのパスを含む文字列。

genericWebPartID

その型のコントロールがコントロールの読み込みまたは作成の失敗に関係する場合、GenericWebPart の ID を返す文字列。

errorMessage

ページ上に表示するエラー メッセージを含む文字列。

戻り値
読み込みまたは作成に失敗したコントロールの代わりにページに挿入する ErrorWebPart。

解説

CreateErrorWebPart メソッドは、Web パーツ コントロール セットが動的な WebPart コントロールまたはサーバー コントロールのインスタンスの読み込みまたは作成を行おうとして、何らかの理由で失敗すると呼び出されます。このメソッドは、ErrorWebPart オブジェクトを作成し、それにエラー メッセージを割り当て、エラー メッセージを返します。ErrorWebPart コントロールは失敗したコントロールの代わりとして挿入され、そのエラー メッセージがページ上に表示されます。

CreateErrorWebPart メソッドを、コードから直接呼び出すことはできません。ただし、WebPartManager クラスから継承してメソッドを拡張できます。詳細については、「継承時の注意」を参照してください。

ページの ErrorWebPart コントロールは通常の WebPart コントロールと良く似ているため、エンド ユーザーはこれと同様に操作できます。このエラー メッセージを削除するには、Close 動詞をクリックしてこのコントロールを終了します。このとき、終了した他のコントロールと同様に、このコントロールが PageCatalogPart オブジェクトに追加されます。エンド ユーザーが ErrorWebPart コントロールを削除すると、読み込みに失敗したサーバー コントロールもページから削除されます。

継承時の注意 ErrorWebPart コントロールで返される情報をカスタマイズする場合は、CreateErrorWebPart メソッドをオーバーライドし、基本メソッドを呼び出して、基本メソッドに渡すパラメータに別の値を割り当て、この結果作成される ErrorWebPart コントロールを返します。たとえば、ユーザー コントロールの仮想ディレクトリ パスを示す originalPath 値をエンド ユーザーに表示しない場合は、基本メソッドを呼び出す際に、パラメータに空の文字列 ("") を渡します。 ErrorWebPart コントロールから継承することにより、このコントロール自体の動作をカスタマイズすることもできます。たとえば、その Title プロパティまたは AllowMinimize プロパティをオーバーライドできます。

プラットフォーム

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 名前空間
ErrorWebPart クラス
その他の技術情報
ASP.NET Web パーツ ページ