Share via


TitleBar.Subtitle Property

Definition

Gets or sets the subtitle text to display in the title bar.

public:
 property Platform::String ^ Subtitle { Platform::String ^ get(); void set(Platform::String ^ value); };
winrt::hstring Subtitle();

void Subtitle(winrt::hstring value);
public string Subtitle { get; set; }
var string = titleBar.subtitle;
titleBar.subtitle = string;
Public Property Subtitle As String

Property Value

String

Platform::String

winrt::hstring

The subtitle text to display in the title bar. The default is an empty string.

Examples

This example shows how to set the Subtitle property to a literal string.

<TitleBar Title="My App" Subtitle="Preview"/>
TitleBar titleBar = new TitleBar();
titleBar.Title = "My App";
titleBar.Subtitle = "Preview";

Remarks

The subtitle is shown to the right of the title. It is typically used to display versioning information, like "Preview" or "Beta".

When the TitleBar is in compact display mode, the Title and Subtitle elements are not shown.

Applies to