WebPartChrome.GetWebPartTitleClientID(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 table cell that contains the title for a WebPart control.

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

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

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

Protected Function GetWebPartTitleClientID (webPart As WebPart) As String

Parameters

webPart: WebPart

The control currently being rendered.

Returns

String

A string that contains the client ID for the title of the webPart.

Exceptions

ArgumentNullException

webPart is null.

Remarks

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.

Applies to