WebPartManager.CreateErrorWebPart 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
当尝试加载或创建动态 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 ,代替无法加载或创建的控件。
注解
CreateErrorWebPart当 Web 部件控件集尝试加载或创建动态WebPart或服务器控件的实例时,将调用该方法,并且由于某种原因而失败。 该方法创建一个 ErrorWebPart 对象,向其分配一条错误消息,并返回该对象。 控件 ErrorWebPart 插入代替失败的控件,并在页面上显示其错误消息。
不能直接从代码调用 CreateErrorWebPart 该方法。 但是,可以从类继承 WebPartManager 并扩展方法。 有关详细信息,请参阅“继承者说明”部分。
最终用户可以在页面中处理控件 ErrorWebPart ,就像使用普通 WebPart 控件一样。 若要删除错误消息,他们可以通过单击关闭谓词来关闭控件,此时控件将添加到对象中,就像任何其他关闭的控件一 PageCatalogPart 样。 如果最终用户删除了控件 ErrorWebPart ,则无法加载的服务器控件也将从页面中删除。
继承者说明
如果要自定义控件中 ErrorWebPart 返回的信息,可以重写 CreateErrorWebPart(String, String, String, String, String) 方法,调用基方法,为传递给基方法的参数分配不同的值,然后返回生成的 ErrorWebPart 控件。 例如,如果不希望最终用户看到 originalPath 值(这将显示用户控件的虚拟目录路径),则调用基方法时,可以传递该参数的空字符串(“”)。
还可以通过继承控件本身来自定义控件本身的行为 ErrorWebPart 。 例如,你可能想要重写其 Title 或 AllowMinimize 属性。