WebPartChrome::GetWebPartTitleClientID Method (WebPart^)

 

Gets the client ID for the table cell that contains the title for a WebPart control.

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

protected:
String^ GetWebPartTitleClientID(
	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 title of the webPart.

Exception Condition
ArgumentNullException

webPart is null.

The GetWebPartTitleClientID method retrieves the client ID value for the table cell that contains the title of the webPart being rendered.

An important scenario in which the GetWebPartTitleClientID method is used to get the client ID of the title cell of the webPart is for the Web Parts drag-and-drop feature. The method is also useful for other client-side scripting purposes. For example, you could change the title or the style of the cell with client-side scripting, rather than having to post the page back to the server.

.NET Framework
Available since 2.0
Return to top
Show: