WebPartChrome.GetWebPartChromeClientID Method (WebPart)

 

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

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

protected string GetWebPartChromeClientID(
	WebPart webPart
)

Parameters

webPart
Type: System.Web.UI.WebControls.WebParts.WebPart

The control currently being rendered.

Return Value

Type: System.String

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

Exception Condition
ArgumentNullException

webPart is null.

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.

.NET Framework
Available since 2.0
Return to top
Show: