WebPartChrome.GetWebPartChromeClientID(WebPart) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the client ID for the WebPartChrome object as rendered in a Web page.

protected:
 System::String ^ GetWebPartChromeClientID(System::Web::UI::WebControls::WebParts::WebPart ^ webPart);

protected string GetWebPartChromeClientID (System.Web.UI.WebControls.WebParts.WebPart webPart);

member this.GetWebPartChromeClientID : System.Web.UI.WebControls.WebParts.WebPart -> string

Protected Function GetWebPartChromeClientID (webPart As WebPart) As String

Parameters

webPart: WebPart

The control currently being rendered.

Returns

String

A string that contains the client ID for the WebPartChrome object.

Exceptions

ArgumentNullException

webPart is null.

Remarks

The GetWebPartChromeClientID method gets the client ID of the table that contains the webPart being rendered. The table is the rendered output that corresponds directly to the WebPartChrome object, and is used as a container to apply styles and create a modular layout for the control.

It is useful to get the client ID of the WebPartChrome object for client-side scripting purposes, if you want to change something in the chrome without having to post the page back to the server.

Applies to