Class DocumentHeader

Presents header of MDI windows.

Inheritance

System.Object

DocumentHeader

Implements

System.IDisposable

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

public class DocumentHeader : Control, IDisposable

Constructors

DocumentHeader()

Initializes a new instance of the DocumentHeader class.

Declaration

public DocumentHeader()

Fields

CloseButtonStyleProperty

Identifies CloseButtonStyle dependency property of the DocumentHeader.

Declaration

public static readonly DependencyProperty CloseButtonStyleProperty

Field Value

Type
System.Windows.DependencyProperty

HeaderProperty

Specifies header of the document.

Declaration

public static readonly DependencyProperty HeaderProperty

Field Value

Type
System.Windows.DependencyProperty

HeaderTemplateProperty

Specifies data template, used to display header of the document. This is an attached dependency property.

Declaration

public static readonly DependencyProperty HeaderTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

IconProperty

Specifies an icon, used for documents. This is an inheritable attached dependency property.

Declaration

public static readonly DependencyProperty IconProperty

Field Value

Type
System.Windows.DependencyProperty

IconSizeProperty

Defines the iconsize that appears in SimpleMenuButton. This is a dependency property.

Declaration

public static readonly DependencyProperty IconSizeProperty

Field Value

Type
System.Windows.DependencyProperty

MaximizeButtonStyleProperty

Identifies MaximizeButtonStyle dependency property of the DocumentHeader.

Declaration

public static readonly DependencyProperty MaximizeButtonStyleProperty

Field Value

Type
System.Windows.DependencyProperty

MinimizeButtonStyleProperty

Identifies MinimizeButtonStyle dependency property of the DocumentHeader.

Declaration

public static readonly DependencyProperty MinimizeButtonStyleProperty

Field Value

Type
System.Windows.DependencyProperty

RestoreButtonStyleProperty

Identifies RestoreButtonStyle dependency property of the DocumentHeader.

Declaration

public static readonly DependencyProperty RestoreButtonStyleProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

CloseButtonStyle

Gets or sets the close button style.

Declaration

public Style CloseButtonStyle { get; set; }

Property Value

Type	Description
System.Windows.Style	The close button style.

Header

Gets or sets the header.

Declaration

public object Header { get; set; }

Property Value

Type	Description
System.Object	The header.

HeaderTemplate

Gets or sets the header template.

Declaration

public DataTemplate HeaderTemplate { get; set; }

Property Value

Type	Description
System.Windows.DataTemplate	The header template.

Icon

Gets or sets the icon.

Declaration

public Brush Icon { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The icon.

IconSize

Gets or sets the size of the icon.

Declaration

public Size IconSize { get; set; }

Property Value

Type	Description
System.Windows.Size	The size of the icon.

MaximizeButtonStyle

Gets or sets the maximize button style.

Declaration

public Style MaximizeButtonStyle { get; set; }

Property Value

Type	Description
System.Windows.Style	The maximize button style.

MinimizeButtonStyle

Gets or sets the minimize button style.

Declaration

public Style MinimizeButtonStyle { get; set; }

Property Value

Type	Description
System.Windows.Style	The minimize button style.

RestoreButtonStyle

Gets or sets the restore button style.

Declaration

public Style RestoreButtonStyle { get; set; }

Property Value

Type	Description
System.Windows.Style	The restore button style.

Methods

Dispose()

Disposes the DocumentHeader while unloading the items of DocumentContainer.

Declaration

public void Dispose()

MeasureOverride(Size)

Declaration

protected override Size MeasureOverride(Size constraint)

Parameters

Type	Name	Description
System.Windows.Size	constraint

Returns

Type
System.Windows.Size

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()

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.

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.

OnMouseRightButtonDown(MouseButtonEventArgs)

Invoke when mouse right button clicked

Declaration

protected override void OnMouseRightButtonDown(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Declaration

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e

Implements

System.IDisposable