CoreApplicationViewTitleBar
CoreApplicationViewTitleBar
CoreApplicationViewTitleBar
CoreApplicationViewTitleBar
Class
Definition
Enables an app to define a custom title bar that displays in the app's window.
public : sealed class CoreApplicationViewTitleBar : ICoreApplicationViewTitleBarpublic sealed class CoreApplicationViewTitleBar : ICoreApplicationViewTitleBarPublic NotInheritable Class CoreApplicationViewTitleBar Implements ICoreApplicationViewTitleBar// This API is not available in Javascript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Properties
ExtendViewIntoTitleBar ExtendViewIntoTitleBar ExtendViewIntoTitleBar ExtendViewIntoTitleBar
Gets or sets a value that specifies whether this title bar should replace the default window title bar.
public : PlatForm::Boolean ExtendViewIntoTitleBar { get; set; }public bool ExtendViewIntoTitleBar { get; set; }Public ReadWrite Property ExtendViewIntoTitleBar As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
Set to true to replace the default window title bar; otherwise, false.
Remarks
The first time the app runs, and for secondary views, the default value is false. For the main view of an app, this value persists between application runs.
Height Height Height Height
Gets the height of the title bar.
public : double Height { get; }public double Height { get; }Public ReadOnly Property Height As double// This API is not available in Javascript.
- Value
- double double double double
The height of the custom title bar.
IsVisible IsVisible IsVisible IsVisible
Gets a value that specifies whether this title bar is visible.
public : PlatForm::Boolean IsVisible { get; }public bool IsVisible { get; }Public ReadOnly Property IsVisible As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if this title bar is visible; otherwise, false.
SystemOverlayLeftInset SystemOverlayLeftInset SystemOverlayLeftInset SystemOverlayLeftInset
Gets the width of the system-reserved region of the upper-left corner of the app window. This region is reserved when the current language is a right-to-left language.
public : double SystemOverlayLeftInset { get; }public double SystemOverlayLeftInset { get; }Public ReadOnly Property SystemOverlayLeftInset As double// This API is not available in Javascript.
- Value
- double double double double
The width of the system-reserved region of the upper-left corner of the app window
Remarks
For applications with custom title bars, the system reserves the option to have system UI drawn in the upper-left or upper-right corner of the app window. The system draws caption buttons in the upper-right for left-to-right languages and the upper-left for right-to-left languages. The width of the reserved region on each side is given by SystemOverlayLeftInset or SystemOverlayRightInset, and its height is given by CoreApplicationViewTitleBar.Height. In the areas described by these regions, apps should not put any UI which they expect the user to be able to interact with.
SystemOverlayRightInset SystemOverlayRightInset SystemOverlayRightInset SystemOverlayRightInset
Gets the width of the system-reserved region of the upper-right corner of the app window. This region is reserved when the current language is a left-to-right language.
public : double SystemOverlayRightInset { get; }public double SystemOverlayRightInset { get; }Public ReadOnly Property SystemOverlayRightInset As double// This API is not available in Javascript.
- Value
- double double double double
The width of the system-reserved region of the upper-right corner of the app window.
Remarks
For applications with custom title bars, the system reserves the option to have system UI drawn in the upper-left or upper-right corner of the app window. The system draws caption buttons in the upper-right for left-to-right languages and the upper-left for right-to-left languages. The width of the reserved region on each side is given by SystemOverlayLeftInset or SystemOverlayRightInset, and its height is given by CoreApplicationViewTitleBar.Height. In the areas described by these regions, apps should not put any UI which they expect the user to be able to interact with.
Events
IsVisibleChanged IsVisibleChanged IsVisibleChanged IsVisibleChanged
Occurs when the visibility of the title bar (indicated by the IsVisible property) changes.
public : event TypedEventHandler IsVisibleChanged<CoreApplicationViewTitleBar, object>public event TypedEventHandler IsVisibleChanged<CoreApplicationViewTitleBar, object>Public Event IsVisibleChanged<CoreApplicationViewTitleBar, object>// This API is not available in Javascript.
LayoutMetricsChanged LayoutMetricsChanged LayoutMetricsChanged LayoutMetricsChanged
Occurs when the title bar needs to respond to size changes. The most common trigger for this event is when the app window moves to a screen that has a different DPI. Use this event to verify and update the positioning of UI elements that depend on the title bar's size.
public : event TypedEventHandler LayoutMetricsChanged<CoreApplicationViewTitleBar, object>public event TypedEventHandler LayoutMetricsChanged<CoreApplicationViewTitleBar, object>Public Event LayoutMetricsChanged<CoreApplicationViewTitleBar, object>// This API is not available in Javascript.