WindowChrome Class

public class WindowChrome : Freezable

public WindowChrome()

public WindowChromeBackdropKind BackdropKind { get; set; }

Property Value

WindowChromeBackdropKind:

A WindowChromeBackdropKind indicating the kind of system-rendered backdrop, which can render special effects over the transparent background portion of a Window. The default value is None.

Remarks

See the WindowChromeBackdropKind enumeration documentation for which Windows versions support its various options. If a backdrop kind is not supported on the current operating system, the Window will use an opaque background.

public bool CanMouseActivateOverToolBar { get; set; }

Property Value

bool:

true if a mouse click on a toolbar control can activate the chromed window; otherwise, false. The default value is true.

Remarks

A toolbar control is any control with an WindowChrome.ElementKind attached property value of ToolBar.

public static ICommand CloseCommand { get; }

Property Value

ICommand:

The ICommand used to close a window.

public WindowChromeCornerKind CornerKind { get; set; }

Property Value

WindowChromeCornerKind:

A WindowChromeCornerKind indicating the kind of system-rendered corner, which can also affect border and drop shadow rendering. The default value is Rounded.

Remarks

This property only affects Windows 11 or later systems. When set to a non-Square value, the Windows system will apply a corner radius to the window and will render the window's border and drop shadow natively. In that scenario, WindowChrome does not render a drop shadow.

On Windows 10 or earlier systems, the corner kind is always treated as Square regardless of this property setting.

public bool HasCloseButton { get; set; }

Property Value

bool:

true if the window is capable of displaying a close button; otherwise, false. The default value is true.

public bool HasIcon { get; set; }

Property Value

bool:

true if the window is capable of displaying a title bar icon; otherwise, false. The default value is true.

public bool? HasMaximizeButton { get; set; }

Property Value

bool?:

true if the window is capable of displaying a maximize button; otherwise, false. The default value is null, meaning base the value on the window's ResizeMode setting.

public bool? HasMinimizeButton { get; set; }

Property Value

bool?:

true if the window is capable of displaying a minimize button; otherwise, false. The default value is null, meaning base the value on the window's ResizeMode setting.

public bool? HasOuterGlow { get; set; }

Property Value

bool?:

true if the window has an outer glow / drop shadow; otherwise, false. The default value is null, meaning use the current theme's default.

Remarks

When this property resolves to true, WindowChrome will render a drop shadow outside of the normal outer window border and window resizing will be supported over a portion of that shadow.

If on a Windows 11 system or later and the CornerKind property is set to a non-Square value, the Windows system will render the drop shadow natively instead of WindowChrome rendering a drop shadow. This HasOuterGlow property can be kept true to ensure that window resizing can still occur over the system-rendered drop shadow.

public bool? HasRestoreButton { get; set; }

Property Value

bool?:

true if the window is capable of displaying a restore button; otherwise, false. The default value is null, meaning base the value on the window's ResizeMode setting.

public bool HasTitleBar { get; set; }

Property Value

bool:

true if the window is capable of displaying a title bar; otherwise, false. The default value is true.

public Thickness IconMargin { get; set; }

Property Value

Thickness:

The window's icon margin. The default value is 8, 2, 8, 2.

public ImageSource IconSource { get; set; }

Property Value

ImageSource:

The window's icon ImageSource, if an alternative one should be used instead of the window's Icon property.

public static ICommand MaximizeCommand { get; }

Property Value

ICommand:

The ICommand used to maximize a window.

public static ICommand MinimizeCommand { get; }

Property Value

ICommand:

The ICommand used to minimize a window.

public static ICommand MoveCommand { get; }

Property Value

ICommand:

The ICommand used to move a window.

public DataTemplate OverlayContentTemplate { get; set; }

Property Value

DataTemplate:

The optional DataTemplate for displaying content over the entire window when the IsOverlayVisible attached property is true.

public DataTemplateSelector OverlayContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The optional DataTemplateSelector for displaying content over the entire window when the IsOverlayVisible attached property is true.

public Thickness? ResizeBorderThickness { get; set; }

Property Value

Thickness?:

The window's resize border thickness. The default value is null, meaning use the current theme's default.

public static ICommand RestoreCommand { get; }

Property Value

ICommand:

The ICommand used to restore a window.

public static ICommand SizeCommand { get; }

Property Value

ICommand:

The ICommand used to size a window.

public object StyleKey { get; set; }

Property Value

object:

The optional resource key that references the Style to assign to windows using this chrome.

public static Thickness SystemResizeBorderThickness { get; }

Property Value

Thickness:

The system window resize border thickness.

public static Thickness SystemTitleBarCaptionButtonMargin { get; }

Property Value

Thickness:

The margin for the title bar content presenter that is needed to avoid overlapping system title bar buttons.

public HorizontalAlignment TitleBarHeaderAlignment { get; set; }

Property Value

HorizontalAlignment:

The optional HorizontalAlignment of the title bar header. The default value is Left.

public Thickness TitleBarHeaderMargin { get; set; }

Property Value

Thickness:

The title bar header's margin. The default value is 8, 0, 8, 0.

Remarks

The left header margin is collapsed to 0 when there is an icon and no custom left title bar content set. Use the IconMargin property to determine the spacing between the icon and the header in that scenario.

public double TitleBarHeaderMinWidth { get; set; }

Property Value

double:

The title bar header minimum width, when not all title bar elements fit in the available space. The default value is 50.

public DataTemplate TitleBarHeaderTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate for the center title bar area where title bar text is typically displayed.

public DataTemplateSelector TitleBarHeaderTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector for the center title bar area where title bar text is typically displayed.

public double TitleBarLeftContentMaxWidthOverflowPercentage { get; set; }

Property Value

double:

The title bar left content area's maximum width percentage of the total title bar space when not all title bar elements fit in the available space. Must be a percentage value between 0.0 and 1.0. The default value is 0.3.

public DataTemplate TitleBarLeftContentTemplate { get; set; }

Property Value

DataTemplate:

The optional DataTemplate that can inject additional controls in the left side of the title bar, next to the icon.

public DataTemplateSelector TitleBarLeftContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The optional DataTemplateSelector that can inject additional controls in the left side of the title bar, next to the icon.

public WindowChromeTitleBarMergeKind TitleBarMergeKind { get; set; }

Property Value

WindowChromeTitleBarMergeKind:

A WindowChromeTitleBarMergeKind indicating the kind of merge that the window content area performs into the title bar areas. The default value is None.

public double TitleBarRightContentMaxWidthOverflowPercentage { get; set; }

Property Value

double:

The title bar right content area's maximum width percentage of the total title bar space when not all title bar elements fit in the available space. Must be a percentage value between 0.0 and 1.0. The default value is 0.3.

public DataTemplate TitleBarRightContentTemplate { get; set; }

Property Value

DataTemplate:

The optional DataTemplate that can inject additional controls in the right side of the title bar, next to the system title bar buttons.

public DataTemplateSelector TitleBarRightContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The optional DataTemplateSelector that can inject additional controls in the right side of the title bar, next to the system title bar buttons.

public static ICommand ToggleIsOverlayVisibleCommand { get; }

Property Value

ICommand:

The ICommand used to toggle the IsOverlayVisible attached property on a window.

protected override Freezable CreateInstanceCore()

Returns

Freezable:

The new instance.

public static WindowChrome GetChrome(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

WindowChrome:

The object's value.

public static WindowChromeElementKind GetElementKind(UIElement element)

Parameter	Type	Description
element	UIElement	The object from which the property value is read.

Returns

WindowChromeElementKind:

The object's value.

Remarks

This attached property is only intended for usage within window templates.

public static bool GetIsBackdropActive(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

bool:

The object's value.

public static bool GetIsOverlayFocusScope(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

bool:

The object's value.

public static bool GetIsOverlayVisible(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

bool:

The object's value.

public static bool GetIsPointerOver(ButtonBase button)

Parameter	Type	Description
button	ButtonBase	The object from which the property value is read.

Returns

bool:

The object's value.

public static bool GetIsTaskbarAutoHidden(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

bool:

The object's value.

public static bool GetIsTitleBarBackdropAllowed(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

bool:

The object's value.

public static Window GetOuterGlow(Window window)

Parameter	Type	Description
window	Window	The Window to examine.

Returns

Window:

The Window that provides an outer glow for the chromed window.

Remarks

This method is for internal use only.

public static OverlayAnimationKinds GetOverlayAnimationKinds(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

OverlayAnimationKinds:

The object's value.

public static object GetOverlayContent(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

object:

The object's value.

public static string GetThemeName(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

string:

The object's value.

Remarks

This attached property is only intended for usage in detecting theme changes.

public static object GetTitleBarHeader(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

object:

The object's value.

public static double GetTitleBarHeight(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

double:

The object's value.

public static object GetTitleBarLeftContent(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

object:

The object's value.

public static double GetTitleBarLeftContentWidth(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

double:

The object's value.

public static double GetTitleBarMinHeight(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

double:

The object's value.

public static object GetTitleBarRightContent(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

object:

The object's value.

public static double GetTitleBarRightContentWidth(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

double:

The object's value.

public static bool GetUseAlternateTitleBarStyle(Window window)

Parameter	Type	Description
window	Window	The object from which the property value is read.

Returns

bool:

The object's value.

public static void OpenSystemMenu(FrameworkElement element, Point point)

Parameter	Type	Description
element	FrameworkElement	The window itself, or an element within a window, such as a title bar icon.
point	Point	The System.Windows.Point at which to display the menu, in coordinates relative to the element.

public static void SetChrome(Window window, WindowChrome value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	WindowChrome	The value to set.

public static void SetElementKind(UIElement element, WindowChromeElementKind value)

Parameter	Type	Description
element	UIElement	The object to which the attached property is written.
value	WindowChromeElementKind	The value to set.

Remarks

This attached property is only intended for usage within window templates.

public static void SetIsOverlayFocusScope(Window window, bool value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	bool	The value to set.

public static void SetIsOverlayVisible(Window window, bool value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	bool	The value to set.

public static void SetIsTitleBarBackdropAllowed(Window window, bool value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	bool	The value to set.

public static void SetOverlayAnimationKinds(Window window, OverlayAnimationKinds value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	OverlayAnimationKinds	The value to set.

public static void SetOverlayContent(Window window, object value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	object	The value to set.

public static void SetThemeName(Window window, string value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	string	The value to set.

Remarks

This attached property is only intended for usage in detecting theme changes.

public static void SetTitleBarHeader(Window window, object value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	object	The value to set.

public static void SetTitleBarLeftContent(Window window, object value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	object	The value to set.

public static void SetTitleBarMinHeight(Window window, double value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	double	The value to set.

public static void SetTitleBarRightContent(Window window, object value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	object	The value to set.

public static void SetUseAlternateTitleBarStyle(Window window, bool value)

Parameter	Type	Description
window	Window	The object to which the attached property is written.
value	bool	The value to set.

public static void SetWindowStyle(Window window, WindowStyle style)

Parameter	Type	Description
window	Window	The Window to update.
style	WindowStyle	The WindowStyle to set.

Remarks

This method ensure that the proper Win32 styles are also updated to render the chrome correctly.

public static void StartResize(Window window, ResizeOperation operation)

Parameter	Type	Description
window	Window	The window.
operation	ResizeOperation	A ResizeOperation that specifies the type of resize.

public event RoutedEventHandler IsOverlayVisibleChanged

Event Type

RoutedEventHandler

public event EventHandler<CancelRoutedEventArgs> TitleBarContextMenuRequested

Event Type

EventHandler<CancelRoutedEventArgs>

public event EventHandler<WindowBoundsChangeEventArgs> WindowBoundsChanged

Event Type

EventHandler<WindowBoundsChangeEventArgs>

public event EventHandler<WindowBoundsChangeEventArgs> WindowBoundsChanging

Event Type

EventHandler<WindowBoundsChangeEventArgs>

public event EventHandler<ContextMenuOpeningEventArgs> WindowSystemMenuOpening

Event Type

EventHandler<ContextMenuOpeningEventArgs>

public static readonly DependencyProperty BackdropKindProperty

public static readonly DependencyProperty CanMouseActivateOverToolBarProperty

public static readonly DependencyProperty ChromeProperty

public static readonly DependencyProperty CornerKindProperty

public static readonly DependencyProperty ElementKindProperty

public static readonly DependencyProperty HasCloseButtonProperty

public static readonly DependencyProperty HasIconProperty

public static readonly DependencyProperty HasMaximizeButtonProperty

public static readonly DependencyProperty HasMinimizeButtonProperty

public static readonly DependencyProperty HasOuterGlowProperty

public static readonly DependencyProperty HasRestoreButtonProperty

public static readonly DependencyProperty HasTitleBarProperty

public static readonly DependencyProperty IconMarginProperty

public static readonly DependencyProperty IconSourceProperty

public static readonly DependencyProperty IsBackdropActiveProperty

public static readonly DependencyProperty IsOverlayFocusScopeProperty

public static readonly RoutedEvent IsOverlayVisibleChangedEvent

public static readonly DependencyProperty IsOverlayVisibleProperty

public static readonly DependencyProperty IsPointerOverProperty

public static readonly DependencyProperty IsTaskbarAutoHiddenProperty

public static readonly DependencyProperty IsTitleBarBackdropAllowedProperty

public static readonly DependencyProperty OverlayAnimationKindsProperty

public static readonly DependencyProperty OverlayContentProperty

public static readonly DependencyProperty OverlayContentTemplateProperty

public static readonly DependencyProperty OverlayContentTemplateSelectorProperty

public static readonly DependencyProperty ResizeBorderThicknessProperty

public static readonly DependencyProperty StyleKeyProperty

public static readonly DependencyProperty ThemeNameProperty

public static readonly RoutedEvent TitleBarContextMenuRequestedEvent

public static readonly DependencyProperty TitleBarHeaderAlignmentProperty

public static readonly DependencyProperty TitleBarHeaderMarginProperty

public static readonly DependencyProperty TitleBarHeaderMinWidthProperty

public static readonly DependencyProperty TitleBarHeaderProperty

public static readonly DependencyProperty TitleBarHeaderTemplateProperty

public static readonly DependencyProperty TitleBarHeaderTemplateSelectorProperty

public static readonly DependencyProperty TitleBarHeightProperty

public static readonly DependencyProperty TitleBarLeftContentMaxWidthOverflowPercentageProperty

public static readonly DependencyProperty TitleBarLeftContentProperty

public static readonly DependencyProperty TitleBarLeftContentTemplateProperty

public static readonly DependencyProperty TitleBarLeftContentTemplateSelectorProperty

public static readonly DependencyProperty TitleBarLeftContentWidthProperty

public static readonly DependencyProperty TitleBarMergeKindProperty

public static readonly DependencyProperty TitleBarMinHeightProperty

public static readonly DependencyProperty TitleBarRightContentMaxWidthOverflowPercentageProperty

public static readonly DependencyProperty TitleBarRightContentProperty

public static readonly DependencyProperty TitleBarRightContentTemplateProperty

public static readonly DependencyProperty TitleBarRightContentTemplateSelectorProperty

public static readonly DependencyProperty TitleBarRightContentWidthProperty

public static readonly DependencyProperty UseAlternateTitleBarStyleProperty

public static readonly RoutedEvent WindowBoundsChangedEvent

public static readonly RoutedEvent WindowBoundsChangingEvent

public static readonly RoutedEvent WindowSystemMenuOpeningEvent