WebPart.DisplayTitle WebPart.DisplayTitle WebPart.DisplayTitle WebPart.DisplayTitle Property

Definition

Gets a string that contains the full title text actually displayed in the title bar of a WebPart control instance.

public:
 property System::String ^ DisplayTitle { System::String ^ get(); };
[System.ComponentModel.Browsable(false)]
public string DisplayTitle { get; }
member this.DisplayTitle : string
Public ReadOnly Property DisplayTitle As String

Property Value

A string that represents the complete, displayed title of the control. The default value is an empty string ("").

Remarks

The DisplayTitle property returns either the current value of the Title property or, if the control has no title, a calculated value. The calculated value consists of a localizable resource string for untitled controls, plus (if there are multiple controls within the zone) a number based on the index of the control within the zone.

For custom WebPart controls where the Subtitle property has been overridden to return a string value to use as a subtitle, the DisplayTitle property is concatenated with the subtitle to produce a complete title.

The DisplayTitle property value also serves as part of a ToolTip that appears when a user positions the mouse pointer over the title bar of a control. The full ToolTip consists of the DisplayTitle value, followed by a hyphen, followed by the value of the control's Description property.

Applies to

See also