WebPartManager.GetDisplayTitle(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 a string containing the value for the DisplayTitle property of a WebPart control.

protected public:
 virtual System::String ^ GetDisplayTitle(System::Web::UI::WebControls::WebParts::WebPart ^ webPart);

protected internal virtual string GetDisplayTitle (System.Web.UI.WebControls.WebParts.WebPart webPart);

abstract member GetDisplayTitle : System.Web.UI.WebControls.WebParts.WebPart -> string
override this.GetDisplayTitle : System.Web.UI.WebControls.WebParts.WebPart -> string

Protected Friend Overridable Function GetDisplayTitle (webPart As WebPart) As String

Parameters

webPart: WebPart

The control for which the method returns the value of DisplayTitle.

Returns

String

A string that contains the calculated value of DisplayTitle for webPart.

Exceptions

ArgumentNullException

webPart is null.

ArgumentException

webPart is not in the Controls collection.

Remarks

Gets the calculated value of the DisplayTitle property for webPart. When developers do not assign a value to the Title property of a WebPart control, this method produces the value to display as the title. The calculated value for untitled controls consists of a number appended to a string, with the number indicating a control's sequence within the current zone.

Notes to Inheritors

This method can be overridden to change how the default display title is calculated.

Applies to

Share via