This documentation is archived and is not being maintained.

WebPartManagerInternals::SetConnectErrorMessage Method

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.

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public:
void SetConnectErrorMessage(
	WebPart^ webPart, 
	String^ connectErrorMessage
)

Parameters

webPart
Type: System.Web.UI.WebControls.WebParts::WebPart
A WebPart that participates in a connection with another control.
connectErrorMessage
Type: System::String
A string that contains the text of the error message.

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: