WebPartManager.CreateErrorWebPart メソッド

定義

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

protected:
 virtual System::Web::UI::WebControls::WebParts::ErrorWebPart ^ CreateErrorWebPart(System::String ^ originalID, System::String ^ originalTypeName, System::String ^ originalPath, System::String ^ genericWebPartID, System::String ^ errorMessage);
protected virtual System.Web.UI.WebControls.WebParts.ErrorWebPart CreateErrorWebPart (string originalID, string originalTypeName, string originalPath, string genericWebPartID, string errorMessage);
abstract member CreateErrorWebPart : string * string * string * string * string -> System.Web.UI.WebControls.WebParts.ErrorWebPart
override this.CreateErrorWebPart : string * string * string * string * string -> System.Web.UI.WebControls.WebParts.ErrorWebPart
Protected Overridable Function CreateErrorWebPart (originalID As String, originalTypeName As String, originalPath As String, genericWebPartID As String, errorMessage As String) As ErrorWebPart

パラメーター

originalID
String

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

originalTypeName
String

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

originalPath
String

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

genericWebPartID
String

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

errorMessage
String

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

戻り値

ErrorWebPart

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

注釈

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

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

エンド ユーザーは、通常WebPartErrorWebPartコントロールと同様に、ページ内のコントロールを操作できます。 エラー メッセージを削除するには、閉じる動詞をクリックしてコントロールを閉じます。その時点で、他の閉じたコントロールと同様に、コントロールがオブジェクトに PageCatalogPart 追加されます。 エンド ユーザーがコントロールを ErrorWebPart 削除すると、読み込みに失敗したサーバー コントロールもページから削除されます。

注意 (継承者)

コントロールで ErrorWebPart 返される情報をカスタマイズする場合は、メソッドをオーバーライド CreateErrorWebPart(String, String, String, String, String) し、基本メソッドを呼び出し、基本メソッドに渡されるパラメーターに異なる値を割り当ててから、結果 ErrorWebPart のコントロールを返すことができます。 たとえば、エンド ユーザーに値を表示 originalPath させたくない場合 (ユーザー コントロールの仮想ディレクトリ パスが表示されます)、基本メソッドを呼び出すときに、そのパラメーターの空の文字列 ("") を渡すことができます。

コントロール自体の ErrorWebPart 動作は、そのコントロールから継承してカスタマイズすることもできます。 たとえば、その Title プロパティまたは AllowMinimize プロパティをオーバーライドできます。

適用対象

こちらもご覧ください