ErrorWebPart.ErrorMessage Property

Definition

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Gets or sets the error message that is displayed in a Web page in place of a control that could not be successfully added to the page.

public:
 property System::String ^ ErrorMessage { System::String ^ get(); void set(System::String ^ value); };

public string ErrorMessage { get; set; }

member this.ErrorMessage : string with get, set

Public Property ErrorMessage As String

Property Value

String

A string that contains the text of the error message. The default value is a culture-specific error message.

Remarks

The ErrorMessage property can be assigned a value by a developer, so that a custom error message is displayed at the point where the ErrorWebPart control is inserted into a page.

Notes to Inheritors

Developers can assign a default value to the ErrorMessage property by extending the ErrorWebPart class and, in the ErrorWebPart(String, String, String, String) constructor or in an overridden EndLoadPersonalization() method, assigning a default value to the property.

To require the WebPartManager control to use a custom ErrorWebPart control, you must also inherit from the WebPartManager class and override its CreateErrorWebPart(String, String, String, String, String) method. In that method, you should assign the value of the method's errorMessage parameter to the ErrorMessage property of your custom ErrorWebPart control, because the WebPartManager control calls this method from several other places, and usually passes in a specific error message.

See also

• CreateErrorWebPart(String, String, String, String, String)
• ASP.NET Web Parts Controls