WebPartManagerInternals.SetConnectErrorMessage(WebPart, String) Method

Definition

Establishes an errors message, and causes the WebPartChrome object that is responsible for rendering a WebPart control to render that message rather than the contents of the control.

public:
 void SetConnectErrorMessage(System::Web::UI::WebControls::WebParts::WebPart ^ webPart, System::String ^ connectErrorMessage);
public void SetConnectErrorMessage (System.Web.UI.WebControls.WebParts.WebPart webPart, string connectErrorMessage);
member this.SetConnectErrorMessage : System.Web.UI.WebControls.WebParts.WebPart * string -> unit
Public Sub SetConnectErrorMessage (webPart As WebPart, connectErrorMessage As String)

Parameters

webPart
WebPart

A WebPart that participates in a connection with another control.

connectErrorMessage
String

A string that contains the text of the error message.

Remarks

The SetConnectErrorMessage method allows you to associate an error message with a WebPart control that participates in connections. If an error occurs when another control is forming a connection with the control referenced by the webPart parameter, then after the connection process has failed, the error message is displayed in the user interface (UI), rather than the contents of webPart.

The WebPartChrome object associated with webPart renders the error message in its RenderPartContents method.

Applies to

See also