AppWindowTitleBar Class

Reference

Definition

Namespace:: Microsoft.UI.Windowing

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.

Edit

Represents the title bar of an app window.

public ref class AppWindowTitleBar sealed

/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AppWindowTitleBar final

[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AppWindowTitleBar

Public NotInheritable Class AppWindowTitleBar

Inheritance: Object Platform::Object IInspectable AppWindowTitleBar

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Remarks

Important

Title bar customization APIs are partially supported on Windows 10 since Windows App SDK 1.2 and fully supported on Windows 11. You should check AppWindowTitleBar.IsCustomizationSupported in your code before you call these APIs to ensure your app doesn't crash on other versions of Windows. See Title bar customization for more info.

Properties

BackgroundColor	Gets or sets the color of the title bar background.
ButtonBackgroundColor	Gets or sets the background color of the title bar buttons.
ButtonForegroundColor	Gets or sets the foreground color of the title bar buttons.
ButtonHoverBackgroundColor	Gets or sets the background color of a title bar button when the pointer is over it.
ButtonHoverForegroundColor	Gets or sets the foreground color of a title bar button when the pointer is over it.
ButtonInactiveBackgroundColor	Gets or sets the background color of a title bar button when it's inactive.
ButtonInactiveForegroundColor	Gets or sets the foreground color of a title bar button when it's inactive.
ButtonPressedBackgroundColor	Gets or sets the background color of a title bar button when it's pressed.
ButtonPressedForegroundColor	Gets or sets the foreground color of a title bar button when it's pressed.
ExtendsContentIntoTitleBar	Gets or sets a value that specifies whether app content extends into the title bar area.
ForegroundColor	Gets or sets the color of the title bar foreground.
Height	Gets the height of the title bar in client coordinates.
IconShowOptions	Gets or sets a value that specifies how the window icon is displayed in the title bar.
InactiveBackgroundColor	Gets or sets the color of the title bar background when it's inactive.
InactiveForegroundColor	Gets or sets the color of the title bar foreground when it's inactive.
LeftInset	Gets the width of the system-reserved region of the upper-left corner of the app window.
PreferredHeightOption	Gets or sets a value that specifies the height options of the title bar when the `AppWindowTitleBar.ExtendsContentIntoTitleBar` property is `true`.
RightInset	Gets the width of the system-reserved region of the upper-right corner of the app window.

Methods

IsCustomizationSupported()	Gets a value that indicates whether the title bar can be customized.
ResetToDefault()	Resets the current title bar back to the default settings for the window.
SetDragRectangles(RectInt32[])	Sets the drag regions for the window.

Applies to