DevZest WPF Docking
DockManager Class |
Provides a set of static methods and attached properties to manage docking behaviors.
Inheritance Hierarchy
Namespace: DevZest.Windows.Docking.Primitives
Assembly: DevZest.WpfDocking (in DevZest.WpfDocking.dll) Version: 2.5.0.0 (2.5.5912.0)
Syntax
The DockManager type exposes the following members.
Methods
Name | Description | |
---|---|---|
GetCanDrag | Gets the value of CanDrag attached property
from a given element. | |
GetDefaultFloatingPreviewSize | Gets the value of DefaultFloatingPreviewSize attached property
from a given DockControl. | |
GetFloatingPreviewHeight | Gets the value of FloatingPreviewHeight attached property
from a given DockControl. | |
GetFloatingPreviewLeft | Gets the value of FloatingPreviewLeft attached property
from a given DockControl. | |
GetFloatingPreviewTop | Gets the value of FloatingPreviewTop attached property
from a given DockControl. | |
GetFloatingPreviewWidth | Gets the value of FloatingPreviewWidth attached property
from a given DockControl. | |
GetFloatingWindowStrategy | Gets the value of FloatingWindowStrategy attached property
from a given DockControl. | |
GetIsEnabled | Gets the value of IsEnabled attached property
from a given DockControl. | |
GetIsShiftKeyDown | Gets the value of IsShiftKeyDown attached property
from a given DockControl. | |
GetOverlay | Gets the value of Overlay attached property
from a given FrameworkElement. | |
GetPreview | Gets the value of Preview attached property
from a given element. | |
GetShowsBottomGuide | Gets the value of ShowsBottomGuide attached property
from a given DockControl. | |
GetShowsFillGuide | Gets the value of ShowsFillGuide attached property
from a given DockControl. | |
GetShowsGuide | Gets the value of ShowsGuide attached property
from a given element. | |
GetShowsLeftGuide | Gets the value of ShowsLeftGuide attached property
from a given DockControl. | |
GetShowsRightGuide | Gets the value of ShowsRightGuide attached property
from a given DockControl. | |
GetShowsTopGuide | Gets the value of ShowsTopGuide attached property
from a given DockControl. | |
GetTargetItem | Gets the value of TargetItem attached property
from a given element. | |
GetTargetPosition | Gets the value of TargetPosition attached property
from a given element. | |
SetCanDrag | Sets the value of CanDrag attached property
for a given element. | |
SetDefaultFloatingPreviewSize | Sets the value of DefaultFloatingPreviewSize attached property
for a given DockControl. | |
SetIsEnabled | Sets the value of IsEnabled attached property
for a given DockControl. | |
SetOverlay | Sets the value of Overlay attached property
for a given FrameworkElement. | |
SetTargetItem | Sets the value of TargetItem attached property
for a given element. | |
SetTargetPosition | Sets the value of TargetPosition attached property
for a given element. |
Fields
Top
Attached Properties
Name | Description | |
---|---|---|
CanDrag | Gets or sets the value indicates whether drag and double click can be initiated for the specified element. | |
DefaultFloatingPreviewSize | Gets or sets the default size of floating preview for a given DockControl. | |
FloatingPreviewHeight | Gets a value indicates the height of the floating preview for a given DockControl. | |
FloatingPreviewLeft | Gets a value indicates the left position of the floating preview for a given DockControl. | |
FloatingPreviewTop | Gets a value indicates the top position of the floating preview for a given DockControl. | |
FloatingPreviewWidth | Gets a value indicates the width of the floating preview for a given DockControl. | |
FloatingWindowStrategy | Gets the value indicates how FloatingWindow objects are displayed for a given DockControl. | |
IsEnabled | Gets or sets the value indicates whether DockManager is enabled for the DockControl. | |
IsShiftKeyDown | Gets a value indicates whether the SHIFT key is pressed down during drag and drop for a given DockControl. | |
Overlay | Gets or sets the Overlay for a given FrameworkElement. | |
Preview | Gets a value indicates where the drop preview should be displayed for specified element. | |
ShowsBottomGuide | Gets a value indicates whether to show bottom docking guide for a given DockControl. | |
ShowsFillGuide | Gets a value indicates whether to show fill docking guide for a given DockControl. | |
ShowsGuide | Gets a value indicates whether docking guide should be displayed for specified element. | |
ShowsLeftGuide | Gets a value indicates whether to show left docking guide for a given DockControl. | |
ShowsRightGuide | Gets a value indicates whether to show right docking guide for a given DockControl. | |
ShowsTopGuide | Gets a value indicates whether to show top docking guide for a given DockControl. | |
TargetItem | Gets or sets the drop target DockItem for specified element. | |
TargetPosition | Gets or sets the target DropPosition for specified element. |
Remarks
By default, the IsEnabled attached property of DockControl is set to . If you change this value, you must provide all the implementation.
DockManager class handles how floating windows are displayed. When running under partial trust, WpfFloatingWindow will be used; otherwise NativeFloatingWindow will be used. You can get the value from FloatingWindowStrategy attached property of DockControl.
DockManager class handles drag and drop through the following attached properties:
- Set CanDrag attached property to for element(s) in control template of WpfFloatingWindow, NativeFloatingWindow, and DockWindow derived classes (ToolWindow and DocumentWindow) to determine where drag and double click can be initiated.
- Set TargetPosition and TargetItem attached property for elements to indicate the drop target.
- The ShowsGuide attached property for DockControl and DockPane indicates whether docking guide should be displayed. The ShowsLeftGuide, ShowsRightGuide, ShowsTopGuide, ShowsBottomGuide and ShowsFillGuide attached properties for DockControl indicate whether the respective docking guide should be displayed. The IsShiftKeyDown attached property for DockControl indicates whether the SHIFT key is pressed down during drag and drop.
- The Preview attached property for DockControl, DockPane or DockItem indicates where the drop preview should be displayed. The FloatingPreviewLeft, FloatingPreviewTop, FloatingPreviewWidth, FloatingPreviewHeight attached properties for DockControl indicates the floating preview size and location.
- In control template, set Overlay attached property for FrameworkElement to display the docking guide and preview overlay. Customize default floating window preview size by changing the value of DefaultFloatingPreviewSize attached property for DockControl.
See Also