Class DockWindow
Main class for dock window Control.
Inheritance
Implements
Namespace: Syncfusion.UI.Xaml.Controls.Layout
Assembly: Syncfusion.SfDockingManager.UWP.dll
Syntax
[ClassReference(IsReviewed = false)]
public class DockWindow : ContentControl, IDisposable
Constructors
DockWindow()
Initializes a new instance of the Syncfusion.Silverlight.DockingManager.DockWindow class.
Declaration
public DockWindow()
Fields
CanAutoHideProperty
Identifies the CanAutoHide dependency property key.
Declaration
public static readonly DependencyProperty CanAutoHideProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
CanCloseProperty
Identifies the CanClose dependency property key.
Declaration
public static readonly DependencyProperty CanCloseProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
CanDockProperty
Identifies the CanDock dependency property key.
Declaration
public static readonly DependencyProperty CanDockProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
CanDocumentProperty
Identifies the CanDocument dependency property key.
Declaration
public static readonly DependencyProperty CanDocumentProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
CanFloatProperty
Identifies the Syncfusion.UI.Xaml.Controls.Layout.DockWindow.CanFloat dependency property key.
Declaration
public static readonly DependencyProperty CanFloatProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
CloseButtonStyleProperty
Identifies the CloseButtonStyle dependency property key.
Declaration
public static readonly DependencyProperty CloseButtonStyleProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
DockStateProperty
Identifies the DockState dependency property key.
Declaration
public static readonly DependencyProperty DockStateProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
HeaderProperty
Identifies the HeaderTemplate dependency property of the SfDockingManager.
Declaration
public static readonly DependencyProperty HeaderProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
IsDragEnabledProperty
Identifies the IsDragEnabled dependency property key.
Declaration
public static readonly DependencyProperty IsDragEnabledProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
MenuButtonStyleProperty
Identifies the MenuButtonStyle dependency property key.
Declaration
public static readonly DependencyProperty MenuButtonStyleProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
PinButtonStyleProperty
Identifies the PinButtonStyle dependency property key.
Declaration
public static readonly DependencyProperty PinButtonStyleProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
Properties
CanAutoHide
Gets or sets a value indicating whether a value indicating whether .
Declaration
public bool CanAutoHide { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if ; otherwise, false. |
CanClose
Gets or sets a value indicating whether a value indicating whether . Stores the Boolean value for DockWindow can able to Close
Declaration
public bool CanClose { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if ; otherwise, false. |
CanDock
Gets or sets a value indicating whether a value indicating whether . Stores the boolean value for DockWindow can able to dock.
Declaration
public bool CanDock { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true If ; otherwise, false. |
CanDocument
Gets or sets a value indicating whether a value indicating whether . Stores the boolean value for DockWindow can able to document
Declaration
public bool CanDocument { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if ; otherwise, false. |
CloseButtonStyle
Gets or sets a value indicating whether the CloseButton Template of the DockWindow.
Declaration
[ClassReference(IsReviewed = false)]
public Style CloseButtonStyle { get; set; }
Property Value
| Type | Description |
|---|---|
| Windows.UI.Xaml.Style | default value is null |
DockState
Gets or sets a value indicating whether the Dock State .
Declaration
public DockState DockState { get; set; }
Property Value
| Type |
|---|
| DockState |
Header
Gets or sets a value indicating whether the header.
Declaration
[ClassReference(IsReviewed = false)]
public string Header { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The header. |
IsDragEnabled
Gets or sets a value indicating whether a value indicating whether . Stores the Boolean value for DockWindow can able to Drag
Declaration
public bool IsDragEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if ; otherwise, false. |
MenuButtonStyle
Gets or sets a value indicating whether the Context menu Template of the DockWindow.
Declaration
[ClassReference(IsReviewed = false)]
public Style MenuButtonStyle { get; set; }
Property Value
| Type | Description |
|---|---|
| Windows.UI.Xaml.Style | default value is null |
PinButtonStyle
Gets or sets a value indicating whether the dockButton Template of the DockWindow.
Declaration
[ClassReference(IsReviewed = false)]
public Style PinButtonStyle { get; set; }
Property Value
| Type | Description |
|---|---|
| Windows.UI.Xaml.Style | default value is null |
Methods
Dispose()
Disposes the instance of DockWindow
Declaration
[ClassReference(IsReviewed = false)]
public void Dispose()
Dispose(Boolean)
Declaration
protected virtual void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing |
Finalize()
Releases unmanaged resources and performs other cleanup operations before the DockWindow is reclaimed by garbage collection.
Declaration
protected override void Finalize()
GetChildren(DockWindow)
Gets the children.
Declaration
protected void GetChildren(DockWindow windowcont)
Parameters
| Type | Name | Description |
|---|---|---|
| DockWindow | windowcont | The dock window. |
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or public processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate.
Declaration
protected override void OnApplyTemplate()
OnCanAutoHidePropertyChanged(DependencyPropertyChangedEventArgs)
Invoked whenever the CanAutoHide property is changed.
Declaration
protected virtual void OnCanAutoHidePropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.DependencyPropertyChangedEventArgs | e | The Windows.UI.Xaml.DependencyPropertyChangedEventArgs that contains the event data. |
OnCanClosePropertyChanged(DependencyPropertyChangedEventArgs)
Invoked whenever the CanDock property is changed.
Declaration
protected virtual void OnCanClosePropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.DependencyPropertyChangedEventArgs | e | The Windows.UI.Xaml.DependencyPropertyChangedEventArgs that contains the event data. |
OnCanDockPropertyChanged(DependencyPropertyChangedEventArgs)
Invoked whenever the CanDock property is changed.
Declaration
protected virtual void OnCanDockPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.DependencyPropertyChangedEventArgs | e | The Windows.UI.Xaml.DependencyPropertyChangedEventArgs that contains the event data. |
OnCanDocumentPropertyChanged(DependencyPropertyChangedEventArgs)
Invoked whenever the Syncfusion.UI.Xaml.Controls.Layout.DockWindow.CanFloat property is changed.
Declaration
protected virtual void OnCanDocumentPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.DependencyPropertyChangedEventArgs | e | The source of the event. |
OnCanDragPropertyChanged(DependencyPropertyChangedEventArgs)
Invoked whenever the IsDragEnabled property is changed.
Declaration
protected virtual void OnCanDragPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.DependencyPropertyChangedEventArgs | e | The Windows.UI.Xaml.DependencyPropertyChangedEventArgs that contains the event data. |
OnCanFloatPropertyChanged(DependencyPropertyChangedEventArgs)
Invoked whenever the Syncfusion.UI.Xaml.Controls.Layout.DockWindow.CanFloat property is changed.
Declaration
protected virtual void OnCanFloatPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.DependencyPropertyChangedEventArgs | e | The source of the event. |
OnDockStateChanged(DependencyPropertyChangedEventArgs)
Invoked whenever the DockState property is changed.
Declaration
protected virtual void OnDockStateChanged(DependencyPropertyChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.DependencyPropertyChangedEventArgs | e | The Windows.UI.Xaml.DependencyPropertyChangedEventArgs that contains the event data. |
OnPointerMoved(PointerRoutedEventArgs)
Handles the MouseMove event of the window control.
Declaration
protected override void OnPointerMoved(PointerRoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.Input.PointerRoutedEventArgs | e |
OnPointerReleased(PointerRoutedEventArgs)
Called before the System.Windows.UIElement.MouseLeftButtonDown event occurs.
Declaration
protected override void OnPointerReleased(PointerRoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.Input.PointerRoutedEventArgs | e | The data for the event. |