Class ChromelessWindow
Represents a customizable window component that allows to modify title bar, resize border, and change the style of the entire window.
Inheritance
Namespace: Syncfusion.Windows.Shared
Assembly: Syncfusion.Shared.WPF.dll
Syntax
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
public class ChromelessWindow : Window
Constructors
ChromelessWindow()
Initializes a new instance of the ChromelessWindow class.
Declaration
public ChromelessWindow()
Fields
CloseButtonTemplateProperty
Identifies CloseButtonTemplate dependency property.
Declaration
public static readonly DependencyProperty CloseButtonTemplateProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
CloseWindow
Command that is executed when click close button in the chromelesswindow
Declaration
public static RoutedUICommand CloseWindow
Field Value
Type |
---|
System.Windows.Input.RoutedUICommand |
CornerRadiusProperty
Identifies CornerRadius dependency property.
Declaration
public static readonly DependencyProperty CornerRadiusProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
HideTaskBarProperty
Declaration
public static readonly DependencyProperty HideTaskBarProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
IconAlignmentProperty
Defines alignment of the window icon.
Declaration
public static readonly DependencyProperty IconAlignmentProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
LeftHeaderItemsSourceProperty
Identifies LeftHeaderItemsSource dependency property.
Declaration
public static readonly DependencyProperty LeftHeaderItemsSourceProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
LeftHeaderItemTemplateProperty
Identifies LeftHeaderItemTemplate dependency property.
Declaration
public static readonly DependencyProperty LeftHeaderItemTemplateProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
MaximizeButtonTemplateProperty
Identifies MaximizeButtonTemplate dependency property.
Declaration
public static readonly DependencyProperty MaximizeButtonTemplateProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
MinimizeButtonTemplateProperty
Identifies MinimizeButtonTemplate dependency property.
Declaration
public static readonly DependencyProperty MinimizeButtonTemplateProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
NavigationBarBackgroundProperty
Identifies NavigationBarBackground dependency property.
Declaration
public static readonly DependencyProperty NavigationBarBackgroundProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ResizeBorderBrushProperty
Identifies ResizeBorderBrushProperty dependency property.
Declaration
public static readonly DependencyProperty ResizeBorderBrushProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ResizeBorderThicknessProperty
Identifies ResizeBorderThickness dependency property.
Declaration
public static readonly DependencyProperty ResizeBorderThicknessProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ResizeGripStyleProperty
Defines Style for the ResizeGrip. This is a dependency property.
Declaration
public static readonly DependencyProperty ResizeGripStyleProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
RestoreButtonTemplateProperty
Identifies RestoreButtonTemplate dependency property.
Declaration
public static readonly DependencyProperty RestoreButtonTemplateProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
RightHeaderItemsSourceProperty
Identifies RightHeaderItemsSource dependency property.
Declaration
public static readonly DependencyProperty RightHeaderItemsSourceProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
RightHeaderItemTemplateProperty
Identifies RightHeaderItemTemplate dependency property.
Declaration
public static readonly DependencyProperty RightHeaderItemTemplateProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ShowIconProperty
Identifies ShowIcon dependency property.
Declaration
public static readonly DependencyProperty ShowIconProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ShowMaximizeButtonProperty
Identifies the ShowMaximizeButton dependency property.
Declaration
public static readonly DependencyProperty ShowMaximizeButtonProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
Remarks
The identifier for the ShowMaximizeButton dependency property.
ShowMinimizeButtonProperty
Identifies the ShowMinimizeButton dependency property.
Declaration
public static readonly DependencyProperty ShowMinimizeButtonProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
Remarks
The identifier for the ShowMinimizeButton dependency property.
ShowTitleProperty
Declaration
public static readonly DependencyProperty ShowTitleProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TitleBarBackgroundProperty
Identifies TitleBarBackground dependency property.
Declaration
public static readonly DependencyProperty TitleBarBackgroundProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TitleBarForegroundProperty
Identifies TitleBarForeground dependency property.
Declaration
public static readonly DependencyProperty TitleBarForegroundProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TitleBarHeightProperty
Identifies TitleBarHeight dependency property.
Declaration
public static readonly DependencyProperty TitleBarHeightProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TitleBarTemplateProperty
Identifies TitleBarTemplate dependency property.
Declaration
public static readonly DependencyProperty TitleBarTemplateProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TitleFontSizeProperty
Identifies TitleFontSize dependency property.
Declaration
public static readonly DependencyProperty TitleFontSizeProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
TitleTextAlignmentProperty
Defines alignment of the Title Text.
Declaration
public static readonly DependencyProperty TitleTextAlignmentProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
ToggleMaximizedState
Command that is executed when click minimize button in the chromelesswindow
Declaration
public static RoutedUICommand ToggleMaximizedState
Field Value
Type |
---|
System.Windows.Input.RoutedUICommand |
ToggleMinimizedState
Command that is executed when click maximize button in the chromelesswindow
Declaration
public static RoutedUICommand ToggleMinimizedState
Field Value
Type |
---|
System.Windows.Input.RoutedUICommand |
UseNativeChromeProperty
Defines NativeChrome for the window. This is a dependency property.
Declaration
public static readonly DependencyProperty UseNativeChromeProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
WindowContentAreaBorderBrushProperty
Identifies WindowContentAreaBorderBrushProperty dependency property.
Declaration
public static readonly DependencyProperty WindowContentAreaBorderBrushProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
WindowCornerRadiusProperty
Identifies WindowCornerRadiusProperty dependency property.
Declaration
public static readonly DependencyProperty WindowCornerRadiusProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
Properties
CloseButtonTemplate
Gets or sets value that represents the template for the Close Button of the TitleBar.
Declaration
public ControlTemplate CloseButtonTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Controls.ControlTemplate | The close button template. |
CornerRadius
Internal value for Gets or sets the corner radius.
Declaration
public CornerRadius CornerRadius { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.CornerRadius | The corner radius. |
Remarks
Remark: The CornerRadius value should be set to a minimum of 4 for effective resizing.
HideTaskBar
Used to hide the TaskBar when WindowStyle set to None.
Declaration
public bool HideTaskBar { get; set; }
Property Value
Type |
---|
System.Boolean |
IconAlignment
Gets or sets value the alignment of the Chromeless Window icon.
Declaration
public IconAlignment IconAlignment { get; set; }
Property Value
Type |
---|
IconAlignment |
Examples
<syncfusion:ChromelessWindow IconAlignment="Left">
</syncfusion:ChromelessWindow>
this.IconAlignment = IconAlignment.Left;
LeftHeaderItemsSource
Gets or sets a collection of objects for the left header items in ChromelessWindow
Declaration
public IEnumerable LeftHeaderItemsSource { get; set; }
Property Value
Type |
---|
System.Collections.IEnumerable |
Examples
this.LeftHeaderItemsSource = (this.DataContext as ViewModel).Utilities;
public class MyObservableCollection : ObservableCollection<object> { }
<syncfusion:ChromelessWindow LeftHeaderItemsSource="{DynamicResource leftHeaderItems}">
<syncfusion:ChromelessWindow.Resources>
<local:MyObservableCollection x:Key="leftHeaderItems">
<syncfusion:SfTextBoxExt Watermark = "Search" />
</ local:MyObservableCollection>
</syncfusion:ChromelessWindow.Resources>
</syncfusion:ChromelessWindow>
LeftHeaderItemTemplate
Gets or sets the data template appied to the left header items when LeftHeaderItemsSource is set in ChromelessWindow
Declaration
public DataTemplate LeftHeaderItemTemplate { get; set; }
Property Value
Type |
---|
System.Windows.DataTemplate |
Examples
<syncfusion:ChromelessWindow LeftHeaderItemTemplate="{DynamicResource Part_LeftItemsTemplate}">
<syncfusion:ChromelessWindow.Resources>
<DataTemplate x:Key="Part_LeftItemsTemplate">
<Grid>
<syncfusion:ButtonAdv SmallIcon="{Binding Path = Icon, Mode = TwoWay}" SizeMode="Small" Background="Transparent" BorderThickness="0" />
</Grid>
</DataTemplate>
</syncfusion:ChromelessWindow.Resources>
</syncfusion:ChromelessWindow>
MaximizeButtonTemplate
Gets or sets value that represents the template for the Maximize Button of the TitleBar.
Declaration
public ControlTemplate MaximizeButtonTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Controls.ControlTemplate | The maximize button template. |
MinimizeButtonTemplate
Gets or sets value that represents the template for the Minimize Button of the TitleBar.
Declaration
public ControlTemplate MinimizeButtonTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Controls.ControlTemplate | The minimize button template. |
NavigationBarBackground
Gets or sets value that represents background brush of
Declaration
public LinearGradientBrush NavigationBarBackground { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.LinearGradientBrush | The navigation bar background. |
ResizeBorderBrush
Gets or sets value that represents border brush of the resizable window.
Declaration
public Brush ResizeBorderBrush { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.Brush | The resize border brush. |
ResizeBorderThickness
Gets or sets value that represents border brush thickness of the resizable window.
Declaration
public Thickness ResizeBorderThickness { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Thickness | The resize border thickness. |
ResizeGripStyle
Gets or sets Style for the ResizeGrip.
Declaration
public Style ResizeGripStyle { get; set; }
Property Value
Type |
---|
System.Windows.Style |
RestoreButtonTemplate
Gets or sets value that represents the template for the Restore Button of the TitleBar.
Declaration
public ControlTemplate RestoreButtonTemplate { get; set; }
Property Value
Type |
---|
System.Windows.Controls.ControlTemplate |
RightHeaderItemsSource
Gets or sets a collection of objects for the right header items in ChromelessWindow
Declaration
public IEnumerable RightHeaderItemsSource { get; set; }
Property Value
Type |
---|
System.Collections.IEnumerable |
Examples
<syncfusion:ChromelessWindow RightHeaderItemsSource="{Binding Utilities}">
</syncfusion:ChromelessWindow>
<syncfusion:ChromelessWindow
xmlns:listCollection="clr-namespace:System.Collections;assembly=mscorlib"
RightHeaderItemsSource="{DynamicResource list}" >
<syncfusion:ChromelessWindow.Resources>
<listCollection:ArrayList x:Key="list" >
<syncfusion:ButtonAdv Width="24" Height="24" SmallIcon="/Images/Help.png" Click="ButtonAdv_Click" SizeMode="Small" Background="Transparent" BorderThickness="0" />
</listCollection:ArrayList>
</syncfusion:ChromelessWindow.Resources>
</syncfusion:ChromelessWindow>
RightHeaderItemTemplate
Gets or sets the data template appied to the right header items when RightHeaderItemsSource is set in ChromelessWindow
Declaration
public DataTemplate RightHeaderItemTemplate { get; set; }
Property Value
Type |
---|
System.Windows.DataTemplate |
Examples
<syncfusion:ChromelessWindow.RightHeaderItemTemplate>
<DataTemplate>
<Grid>
<syncfusion:ButtonAdv SmallIcon="{Binding Path = Icon, Mode = TwoWay}" Command="{Binding Path= Command, Mode=TwoWay}" SizeMode="Small" Background="Transparent" BorderThickness="0" />
</Grid>
</DataTemplate>
</syncfusion:ChromelessWindow.RightHeaderItemTemplate>
ShowIcon
Gets or sets a value indicating whether [show icon].
Declaration
public bool ShowIcon { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowMaximizeButton
Gets or sets a Boolean value that indicates whether the maximize button can be visible in title bar of the ChromelessWindow.
Declaration
public bool ShowMaximizeButton { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if maximize button is visible in ChromelessWindow ; otherwise, false. The default value is true. |
Remarks
When
ShowMinimizeButton
Gets or sets a value that indicates whether the minimize button can be visible in title bar of the ChromelessWindow.
Declaration
public bool ShowMinimizeButton { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if minimize button is visible in ChromelessWindow ; otherwise, false. The default value is true. |
Remarks
When
ShowTitle
Gets or sets a Boolean value that indicates whether the title can be visible in title bar of the ChromelessWindow.
Declaration
public bool ShowTitle { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the title is visible in ChromelessWindow ; otherwise, false. The default value is true. |
TitleBar
Gets the title bar.
Declaration
public TitleBar TitleBar { get; }
Property Value
Type | Description |
---|---|
TitleBar | The title bar. |
TitleBarBackground
Gets or sets value that represents background brush of TitleBar.
Declaration
public Brush TitleBarBackground { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.Brush | The title bar background. |
TitleBarForeground
Gets or sets value that represents background brush of TitleBar.
Declaration
public Brush TitleBarForeground { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.Brush | The title bar background. |
TitleBarHeight
Gets or sets the titleBarHeight.
Declaration
public double TitleBarHeight { get; set; }
Property Value
Type |
---|
System.Double |
Remarks
The default size is 30.0
TitleBarTemplate
Gets or sets value that represents the template for the TitleBar.
Declaration
public ControlTemplate TitleBarTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Controls.ControlTemplate | The title bar template. |
TitleFontSize
Gets or sets the TitleFontSize
Declaration
public double TitleFontSize { get; set; }
Property Value
Type |
---|
System.Double |
Remarks
The default size is 12.0 The minimum TitleFontSize is 0.1
TitleTextAlignment
Gets or sets value that represents the Title text alignment.
Declaration
public HorizontalAlignment TitleTextAlignment { get; set; }
Property Value
Type |
---|
System.Windows.HorizontalAlignment |
UseNativeChrome
Gets or sets NativeChrome property set for the window.
Declaration
public bool UseNativeChrome { get; set; }
Property Value
Type |
---|
System.Boolean |
WindowContentAreaBorderBrush
Gets or sets the value that represents background of window content area.
Declaration
public Brush WindowContentAreaBorderBrush { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.Brush | The window content area border brush. |
Methods
add_ReSizeGripMouseEvent(ChromelessWindow.ReSizeGripMouseEventHandler)
Declaration
public void add_ReSizeGripMouseEvent(ChromelessWindow.ReSizeGripMouseEventHandler value)
Parameters
Type | Name | Description |
---|---|---|
ChromelessWindow.ReSizeGripMouseEventHandler | value |
ArrangeOverride(Size)
Override this method to arrange and size a window and its child elements.
Declaration
protected override Size ArrangeOverride(Size arrangeBounds)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Size | arrangeBounds | A System.Windows.Size that reflects the final size that the window should use to arrange itself and its children. |
Returns
Type | Description |
---|---|
System.Windows.Size | A System.Windows.Size that reflects the actual size that was used. |
MeasureOverride(Size)
Override this method to measure the size of a window.
Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Size | availableSize | A System.Windows.Size that reflects the available size that this window can give to the child. Infinity can be given as a value to indicate that the window will size to whatever content is available. |
Returns
Type | Description |
---|---|
System.Windows.Size | A System.Windows.Size that reflects the size that this window determines it needs during layout, based on its calculations of children's sizes. |
OnApplyTemplate()
Called when an internal process or application calls ApplyTemplate, which is used to build the current template's visual tree.
Declaration
public override void OnApplyTemplate()
OnIsGlassActiveChanged(DependencyPropertyChangedEventArgs)
Raises IsGlassActiveChanged event.
Declaration
protected virtual void OnIsGlassActiveChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyPropertyChangedEventArgs | e | Property change details, such as old value and new value. |
OnMouseDown(MouseButtonEventArgs)
Invoked when an unhandled System.Windows.Input.Mouse.MouseDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
Declaration
protected override void OnMouseDown(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e | The System.Windows.Input.MouseButtonEventArgs that contains the event data. This event data reports details about the mouse button that was pressed and the handled state. |
OnMouseLeftButtonUp(MouseButtonEventArgs)
Invoked when an unhandled MouseLeftButtonUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e | The event data |
OnMouseMove(MouseEventArgs)
Invoked on MouseDown
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseEventArgs | e |
OnMouseUp(MouseButtonEventArgs)
Invoked when an unhandled System.Windows.Input.Mouse.MouseUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
Declaration
protected override void OnMouseUp(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e | The System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that the mouse button was released. |
OnPreviewMouseLeftButtonDown(MouseButtonEventArgs)
Invoked when an unhandled System.Windows.UIElement.PreviewMouseLeftButtonDown routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
Declaration
protected override void OnPreviewMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e | The System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was pressed. |
OnPreviewMouseLeftButtonUp(MouseButtonEventArgs)
Declaration
protected override void OnPreviewMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e |
OnPreviewMouseMove(MouseEventArgs)
Invoked when an unhandled System.Windows.Input.Mouse.PreviewMouseMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
Declaration
protected override void OnPreviewMouseMove(MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseEventArgs | e | The System.Windows.Input.MouseEventArgs that contains the event data. |
OnPropertyChanged(DependencyPropertyChangedEventArgs)
Invoked whenever the effective value of any dependency property on this System.Windows.FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides System.Windows.DependencyObject.OnPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs).
Declaration
protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyPropertyChangedEventArgs | e | The event data that describes the property that changed, as well as old and new values. |
OnSourceInitialized(EventArgs)
Raises the System.Windows.Window.SourceInitialized event.
Declaration
protected override void OnSourceInitialized(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e | An System.EventArgs that contains the event data. |
remove_ReSizeGripMouseEvent(ChromelessWindow.ReSizeGripMouseEventHandler)
Declaration
public void remove_ReSizeGripMouseEvent(ChromelessWindow.ReSizeGripMouseEventHandler value)
Parameters
Type | Name | Description |
---|---|---|
ChromelessWindow.ReSizeGripMouseEventHandler | value |
SystemButtonsUpdate()
Updates system buttons visibility.
Declaration
protected void SystemButtonsUpdate()
Events
IsGlassActiveChanged
Occurs when [is glass active changed].
Declaration
public event PropertyChangedCallback IsGlassActiveChanged
Event Type
Type |
---|
System.Windows.PropertyChangedCallback |
ReSizeGripMouseEvent
Occurs when the mouse event is being resize in a grip.
Declaration
public event ChromelessWindow.ReSizeGripMouseEventHandler ReSizeGripMouseEvent
Event Type
Type |
---|
ChromelessWindow.ReSizeGripMouseEventHandler |