This documentation is archived and is not being maintained.

WebPartChrome::GetWebPartTitleClientID Method

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.

ExceptionCondition
ArgumentNullException

webPart is nullptr.

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

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: