Class DockHeaderPresenter

Control that is used to represent the header of the docked element.

Inheritance

System.Object

DockHeaderPresenter

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

public sealed class DockHeaderPresenter : Control

Remarks

You can use DockHeaderPresenter class to make header of the dock window. When you create some dock window, there will be header inside. DockHeaderPresenter can be useful when you override some template, for example template of the SidePanel.

Examples

This example shows how to use DockHeaderPresenter class in XAML.

<Syncfusion:DockHeaderPresenter x:Name="PART_Header" DockPanel.Dock="Top" IsRichHeader="False" 
Style="{Binding Path=(Syncfusion:DockingManager.DockHeaderStyle)
, RelativeSource={RelativeSource AncestorType={x:Type Syncfusion:DockingManager}}}"
IsTemplateParenKeyboardFocusWithin="{TemplateBinding IsShowedFocusedItem}"/>

Constructors

DockHeaderPresenter()

Initializes a new instance of the DockHeaderPresenter class.

Declaration

public DockHeaderPresenter()

Fields

ChangeAwlStateCommand

Represents the ChangeAwlState command, which requests that element be moved to auto hidden or dock state.

Declaration

public static RoutedUICommand ChangeAwlStateCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

CloseCommand

Represents the Close command, which requests that element be moved to hidden state.

Declaration

public static RoutedUICommand CloseCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

ElementHostProperty

Identifies the ElementHost dependency Property

Declaration

public static readonly DependencyProperty ElementHostProperty

Field Value

Type	Description
System.Windows.DependencyProperty

IsRichHeaderProperty

Identifies the IsRichHeader dependency property.

Declaration

public static readonly DependencyProperty IsRichHeaderProperty

Field Value

Type	Description
System.Windows.DependencyProperty

IsTemplateParenKeyboardFocusWithinProperty

Identifies the IsTemplateParenKeyboardFocusWithin dependency property.

Declaration

public static readonly DependencyProperty IsTemplateParenKeyboardFocusWithinProperty

Field Value

Type	Description
System.Windows.DependencyProperty

MaximizeStateCommand

Represents the MaximizeState command, which requests that element be moved to maximize window state.

Declaration

public static RoutedUICommand MaximizeStateCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

MinimizeStateCommand

Represents the MinimizeState command, which requests that element be moved to Minimize window state.

Declaration

public static RoutedUICommand MinimizeStateCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

OpenContextMenuCommand

Represents the OpenContextMenu command, which requests that context menu be opened on the header.

Declaration

public static RoutedUICommand OpenContextMenuCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

ProcessDoubleClickProperty

Identifies the ProcessDoubleClick dependency property.

Declaration

public static readonly DependencyProperty ProcessDoubleClickProperty

Field Value

Type	Description
System.Windows.DependencyProperty

RestoreStateCommand

Represents the RestoreState command, which requests that element be moved to Restore window state.

Declaration

public static RoutedUICommand RestoreStateCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

UseNativeFloatWindowProperty

Identifies the UseNativeFloatWindow dependency Property

Declaration

public static readonly DependencyProperty UseNativeFloatWindowProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Properties

ElementHost

Gets or sets the ElementHost

Declaration

public DockedElementTabbedHost ElementHost { get; }

Property Value

Type	Description
DockedElementTabbedHost	The ElementHost

IsRichHeader

Gets or sets a value indicating whether header belongs to element in docked or auto hidden states. This is a dependency property.

Declaration

public bool IsRichHeader { get; set; }

Property Value

Type	Description
System.Boolean	Type: System.Boolean Provides IsRichHeader value for the DockHeaderPresenter.

Remarks

Default value of this property is true.

Examples

When you initialize DockHeaderPresenter template, you can set this property. This example shows how to use IsRichHeader property in XAML.

        <Syncfusion:DockHeaderPresenter x:Name="PART_Header" DockPanel.Dock="Top" IsRichHeader="False" 
                 Style="{Binding Path=(Syncfusion:DockingManager.DockHeaderStyle)
                 , RelativeSource={RelativeSource AncestorType={x:Type Syncfusion:DockingManager}}}"
                 IsTemplateParenKeyboardFocusWithin="{TemplateBinding IsShowedFocusedItem}"/>

See Also

System.Boolean

IsTemplateParenKeyboardFocusWithin

Gets or sets a value indicating whether template parent has keyboard focus. This is a dependency property.

Declaration

public bool IsTemplateParenKeyboardFocusWithin { get; set; }

Property Value

Type	Description
System.Boolean	Type: System.Boolean Provides IsTemplateParenKeyboardFocusWithin value for the DockHeaderPresenter.

Remarks

Default value of this property is false.

Examples

To set IsTemplateParenKeyboardFocusWithin property please see IsRichHeader property example.

See Also

System.Boolean

ProcessDoubleClick

Gets or sets a value indicating whether state can be changed after double click. This is a dependency property.

Declaration

public bool ProcessDoubleClick { get; set; }

Property Value

Type	Description
System.Boolean	Type: System.Boolean Provides ProcessDoubleClick value for the DockHeaderPresenter.

Remarks

ProcessDoubleClick property gets or sets the value indicating whether double click on the header of the dock window can be processed. Default value of this property is true.

Examples

When you override DockHeaderPresenter template, you can use this property to set when double click on header can be processed. This example shows how to use ProcessDoubleClick property in XAML.

    <Trigger Property="utilsOuter:SkinStorage.VisualStyle" Value="Blend">
       <Setter Property="ProcessDoubleClick" Value="False" />
   </Trigger>

See Also

System.Boolean

UseNativeFloatWindow

Declaration

public bool UseNativeFloatWindow { get; }

Property Value

Type	Description
System.Boolean

Methods

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate

Declaration

public override void OnApplyTemplate()

OnCreateAutomationPeer()

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Type	Description
System.Windows.Automation.Peers.AutomationPeer

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.Windows.RoutedEventArgs that contains the event data.

OnMouseDoubleClick(MouseButtonEventArgs)

Raises the System.Windows.Controls.Control.MouseDoubleClick routed event.

Declaration

protected override void OnMouseDoubleClick(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e	The event data.

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.

OnMouseLeave(MouseEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseLeave�attached event is raised on this element. Implement this method to add class handling for this event.

Declaration

protected override void OnMouseLeave(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseEventArgs	e	The System.Windows.Input.MouseEventArgs that contains the event data.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.MouseLeftButtonDown�routed event is raised on this element. Implement this method to add class handling for this event.

Declaration

protected override void OnMouseLeftButtonDown(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

OnMouseLeftButtonUp(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.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 System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was released.

OnMouseMove(MouseEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseMove�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 OnMouseMove(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseEventArgs	e	The System.Windows.Input.MouseEventArgs that contains the event data.

OnMouseRightButtonDown(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.MouseRightButtonDown�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 OnMouseRightButtonDown(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 right mouse button was pressed.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Declaration

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e