In This Article

DockSite Class

Represents a dock site, the root control for docking window host functionality.

[TemplatePart(Name = "PART_AdornmentHost", Type = typeof(Panel))]
[TemplatePart(Name = "PART_DockHost", Type = typeof(DockHost))]
public class DockSite : Control, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient, IDockTarget, IHierarchyNode
Inheritance:
Object DispatcherObject DependencyObject Visual UIElement FrameworkElement Control Object
Implements:
IDockTarget

Constructors

DockSite()

Initializes an instance of the DockSite class.

public DockSite()

Properties

ActivateNextDocumentCommand

Gets the ICommand that can activate the next document.

public ICommand ActivateNextDocumentCommand { get; }

Property Value

ICommand:

The ICommand that can activate the next document.

ActivateNextTabCommand

Gets the ICommand that can activate the next tab.

public ICommand ActivateNextTabCommand { get; }

Property Value

ICommand:

The ICommand that can activate the next tab.

ActivatePreviousDocumentCommand

Gets the ICommand that can activate the previous document.

public ICommand ActivatePreviousDocumentCommand { get; }

Property Value

ICommand:

The ICommand that can activate the previous document.

ActivatePreviousTabCommand

Gets the ICommand that can activate the previous tab.

public ICommand ActivatePreviousTabCommand { get; }

Property Value

ICommand:

The ICommand that can activate the previous tab.

ActivatePrimaryDocumentCommand

Gets the ICommand that can activate the primary document.

public ICommand ActivatePrimaryDocumentCommand { get; }

Property Value

ICommand:

The ICommand that can activate the primary document.

ActiveWindow

Gets the DockingWindow that is currently active.

public DockingWindow ActiveWindow { get; }

Property Value

DockingWindow:

The DockingWindow that is currently active.

Remarks

Only one docking window can be active at any given time.

AreDocumentWindowsDestroyedOnClose

Gets or sets whether document windows are automatically destroyed (removed from the DockSite) when closed.

public bool AreDocumentWindowsDestroyedOnClose { get; set; }

Property Value

Boolean:

true if document windows are automatically destroyed (removed from the DockSite) when closed; otherwise, false. The default value is true.

AreNewTabsInsertedBeforeExistingTabs

Gets or sets whether new tabs are inserted before existing tabs when they are added, such as when dragging and attaching a tool window to an existing tool window container.

public bool AreNewTabsInsertedBeforeExistingTabs { get; set; }

Property Value

Boolean:

true if new tabs are inserted before existing tabs when they are added; otherwise, false. The default value is true.

AutoHideBottomContainers

Gets the collection of ToolWindowContainer items that appear in the primary bottom auto-hide tabstrip.

public ToolWindowContainerCollection AutoHideBottomContainers { get; }

Property Value

ToolWindowContainerCollection:

The collection of ToolWindowContainer items that appear in the primary bottom auto-hide tabstrip.

AutoHideLeftContainers

Gets the collection of ToolWindowContainer items that appear in the primary left auto-hide tabstrip.

public ToolWindowContainerCollection AutoHideLeftContainers { get; }

Property Value

ToolWindowContainerCollection:

The collection of ToolWindowContainer items that appear in the primary left auto-hide tabstrip.

AutoHidePerContainer

Gets or sets whether auto-hide state toggles affect all the windows in the parent ToolWindowContainer.

public bool AutoHidePerContainer { get; set; }

Property Value

Boolean:

true if auto-hide state toggles affect all the windows in the parent ToolWindowContainer; otherwise, false. The default value is true.

AutoHidePopupCloseAnimationDuration

Gets or sets the duration in milliseconds of the animation that is applied to an auto-hide popup close.

public double AutoHidePopupCloseAnimationDuration { get; set; }

Property Value

Double:

The duration in milliseconds of the animation that is applied to an auto-hide popup close. The default value is 150ms.

AutoHidePopupCloseDelay

Gets or sets the duration in milliseconds of the delay between when the pointer leaves an auto-hide popup and when the popup closes if the pointer has not moved back over the popup.

public double AutoHidePopupCloseDelay { get; set; }

Property Value

Double:

The duration in milliseconds of the delay between when the pointer leaves an auto-hide popup and when the popup closes if the pointer has not moved back over the popup. The default value is 500ms.

AutoHidePopupClosesOnLostFocus

Gets or sets whether the auto-hide popup closes when keyboard focus is moved outside of the popup.

public bool AutoHidePopupClosesOnLostFocus { get; set; }

Property Value

Boolean:

true if the auto-hide popup closes when keyboard focus is moved outside of the popup; otherwise, false. The default value is true.

Remarks

This property can be temporarily set to false while a dialog window is displayed from a tool window that is currently within an auto-hide popup. This prevents the popup from closing while the dialog is displayed.

AutoHidePopupOpenAnimationDuration

Gets or sets the duration in milliseconds of the animation that is applied to an auto-hide popup open.

public double AutoHidePopupOpenAnimationDuration { get; set; }

Property Value

Double:

The duration in milliseconds of the animation that is applied to an auto-hide popup open. The default value is 150ms.

AutoHidePopupOpenDelay

Gets or sets the duration in milliseconds of the delay between when the pointer moves over an auto-hide tab item and the auto-hide popup opens to display the tool window represented by the tab item.

public double AutoHidePopupOpenDelay { get; set; }

Property Value

Double:

The duration in milliseconds of the delay between when the pointer moves over an auto-hide tab item and the auto-hide popup opens to display the tool window represented by the tab item. The default value is 200ms.

AutoHidePopupOpensOnMouseHover

Gets or sets whether the auto-hide popup displays when the mouse hovers over an auto-hide tab item.

public bool AutoHidePopupOpensOnMouseHover { get; set; }

Property Value

Boolean:

true if the auto-hide popup displays when the mouse hovers over an auto-hide tab item; otherwise, false. The default value is false for most themes, but may be true for some themes.

AutoHideRightContainers

Gets the collection of ToolWindowContainer items that appear in the primary right auto-hide tabstrip.

public ToolWindowContainerCollection AutoHideRightContainers { get; }

Property Value

ToolWindowContainerCollection:

The collection of ToolWindowContainer items that appear in the primary right auto-hide tabstrip.

AutoHideTabItemTemplate

Gets or sets the DataTemplate to use for rendering the auto-hide tab items.

public DataTemplate AutoHideTabItemTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for rendering the auto-hide tab items.

AutoHideTabItemTemplateSelector

Gets or sets the DataTemplateSelector to use for rendering the auto-hide tab items.

public DataTemplateSelector AutoHideTabItemTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for rendering the auto-hide tab items.

AutoHideTopContainers

Gets the collection of ToolWindowContainer items that appear in the primary top auto-hide tabstrip.

public ToolWindowContainerCollection AutoHideTopContainers { get; }

Property Value

ToolWindowContainerCollection:

The collection of ToolWindowContainer items that appear in the primary top auto-hide tabstrip.

CanDocumentWindowsClose

Gets or sets the global setting for whether document windows can be closed.

public bool CanDocumentWindowsClose { get; set; }

Property Value

Boolean:

true if document windows can be closed; otherwise, false. The default value is true.

Remarks

This setting only affects document windows whose CanClose property is set to null. Any other setting on the document window instance overrides this global setting.

CanDocumentWindowsDragToLinkedDockSites

Gets or sets the global setting for whether document windows may be dragged to a linked DockSite.

public bool CanDocumentWindowsDragToLinkedDockSites { get; set; }

Property Value

Boolean:

true if document windows may be dragged to a linked DockSite; otherwise, false. The default value is true.

Remarks

This setting only affects document windows whose CanDragToLinkedDockSites property is set to null. Any other setting on the document window instance overrides this global setting.

CanDocumentWindowsFloat

Gets or sets the global setting for whether document windows may be contained in a floating window.

public bool CanDocumentWindowsFloat { get; set; }

Property Value

Boolean:

true if document windows may be contained in a floating window; otherwise, false. The default value is false.

Remarks

This setting only affects document windows whose CanFloat property is set to null. Any other setting on the document window instance overrides this global setting.

CanFloatingDockHostsHideOnDockSiteUnload

Gets or sets whether FloatingDockHosts should hide when the DockSite is unloaded, such as in nested DockSite scenarios when the parent tab is deselected.

public bool CanFloatingDockHostsHideOnDockSiteUnload { get; set; }

Property Value

Boolean:

true if FloatingDockHosts should hide when the DockSite is unloaded; otherwise, false. The default value is true.

CanToolWindowsAttach

Gets or sets the global setting for whether tool windows may be attached to another tool window, creating a tabbed grouping.

public bool CanToolWindowsAttach { get; set; }

Property Value

Boolean:

true if tool windows may be attached to another tool window; otherwise, false. The default value is true.

Remarks

This setting only affects tool windows whose CanAttach property is set to null. Any other setting on the tool window instance overrides this global setting.

CanToolWindowsAutoHide

Gets or sets the global setting for whether tool windows may be placed in auto-hide mode.

public bool CanToolWindowsAutoHide { get; set; }

Property Value

Boolean:

true if tool windows may be placed in auto-hide mode; otherwise, false. The default value is true.

Remarks

This setting only affects tool windows whose CanAutoHide property is set to null. Any other setting on the tool window instance overrides this global setting.

CanToolWindowsBecomeDocuments

Gets or sets the global setting for whether tool windows may be placed in a document state.

public bool CanToolWindowsBecomeDocuments { get; set; }

Property Value

Boolean:

true if tool windows may be placed in a document state; otherwise, false. The default value is true.

Remarks

This setting only affects tool windows whose CanBecomeDocument property is set to null. Any other setting on the tool window instance overrides this global setting.

CanToolWindowsClose

Gets or sets the global setting for whether tool windows can be closed.

public bool CanToolWindowsClose { get; set; }

Property Value

Boolean:

true if tool windows can be closed; otherwise, false. The default value is true.

Remarks

This setting only affects tool windows whose CanClose property is set to null. Any other setting on the tool window instance overrides this global setting.

CanToolWindowsCloseOnMiddleClick

Gets or sets a value indicating whether tool windows can be closed by clicking the tab with the middle mouse button.

public bool CanToolWindowsCloseOnMiddleClick { get; set; }

Property Value

Boolean:

true if tool windows can be closed by clicking the tab with the middle mouse button; otherwise, false. The default value is true.

CanToolWindowsDock

Gets or sets the global setting for whether tool windows can be docked.

public bool CanToolWindowsDock { get; set; }

Property Value

Boolean:

true if tool windows can be docked; otherwise, false. The default value is true.

Remarks

This setting only affects tool windows whose CanDock property is set to null. Any other setting on the tool window instance overrides this global setting.

CanToolWindowsDragToFloatingDockHostsWithWorkspaces

Gets or sets the whether tool windows may be dragged to floating dock hosts that contain a workspace.

public bool CanToolWindowsDragToFloatingDockHostsWithWorkspaces { get; set; }

Property Value

Boolean:

true if tool windows may be dragged to floating dock hosts that contain a workspace; otherwise, false. The default value is true.

Remarks

When false, tool windows can still be dragged and docked against floating dock hosts that only contain tool windows.

CanToolWindowsDragToLinkedDockSites

Gets or sets the global setting for whether tool windows may be dragged to a linked DockSite.

public bool CanToolWindowsDragToLinkedDockSites { get; set; }

Property Value

Boolean:

true if tool windows may be dragged to a linked DockSite; otherwise, false. The default value is true.

Remarks

This setting only affects tool windows whose CanDragToLinkedDockSites property is set to null. Any other setting on the tool window instance overrides this global setting.

CanToolWindowsFloat

Gets or sets the global setting for whether tool windows may be floated into separate top-level containers.

public bool CanToolWindowsFloat { get; set; }

Property Value

Boolean:

true if tool windows may be floated into separate top-level containers; otherwise, false. The default value is true.

Remarks

This setting only affects tool windows whose CanFloat property is set to null. Any other setting on the tool window instance overrides this global setting.

CanToolWindowTabsDrag

Gets or sets the global setting for whether tool window tabs may be dragged to another location.

public bool CanToolWindowTabsDrag { get; set; }

Property Value

Boolean:

true if tool window tabs may be dragged to another location; otherwise, false. The default value is true.

Remarks

This setting only affects tool windows whose CanDragTab property is set to null. Any other setting on the tool window instance overrides this global setting.

CanUpdateItemsSourceOnUnregister

Gets or sets whether to try and remove an item from its items source when the related container DockingWindow is unregistered.

public bool CanUpdateItemsSourceOnUnregister { get; set; }

Property Value

Boolean:

true if the item should try to be removed; otherwise, false. The default value is true.

Remarks

This feature is only active when using the DocumentItemsSource or ToolItemsSource properties, and the functionality only works if the items source implements IList and is not read-only. Otherwise, the WindowUnregistered event should be monitored and the items source updated manually.

CascadeDocumentsCommand

Gets the ICommand that can cascade the open documents.

public ICommand CascadeDocumentsCommand { get; }

Property Value

ICommand:

The ICommand that can cascade the open documents.

Child

Gets or sets the FrameworkElement that is the child content of this dock site.

public FrameworkElement Child { get; set; }

Property Value

FrameworkElement:

The FrameworkElement that is the child content of this dock site.

CloseAllDocumentsCommand

Gets the ICommand that can close all open documents.

public ICommand CloseAllDocumentsCommand { get; }

Property Value

ICommand:

The ICommand that can close all open documents.

ClosePerContainer

Gets or sets whether close operations affect all the windows in the parent ToolWindowContainer.

public bool ClosePerContainer { get; set; }

Property Value

Boolean:

true if close operations affect all the windows in the parent ToolWindowContainer; otherwise, false. The default value is false.

ClosePrimaryDocumentCommand

Gets the ICommand that can close the primary document.

public ICommand ClosePrimaryDocumentCommand { get; }

Property Value

ICommand:

The ICommand that can close the primary document.

DocumentItemContainerStyle

Gets or sets the Style that is applied to the container DockingWindow generated for each document item.

public Style DocumentItemContainerStyle { get; set; }

Property Value

Style:

The Style that is applied to the container DockingWindow generated for each document item. The default value is null.

DocumentItemContainerStyleSelector

Gets or sets custom style-selection logic for a style that can be applied to each generated container DockingWindow.

public StyleSelector DocumentItemContainerStyleSelector { get; set; }

Property Value

StyleSelector:

A StyleSelector object that contains logic that chooses the style to use as the DocumentItemContainerStyle. The default value is null.

DocumentItemsSource

Gets or sets a collection used to generate document windows for use in the DockSite.

public IEnumerable DocumentItemsSource { get; set; }

Property Value

IEnumerable:

A collection that is used to generate generate document windows for use in the DockSite. The default value is null.

DocumentItemTemplate

Gets or sets the DataTemplate used to display each document item.

public DataTemplate DocumentItemTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that specifies the visualization of the data objects. The default value is null.

DocumentItemTemplateSelector

Gets or sets the custom logic for choosing a template used to display each document item.

public DataTemplateSelector DocumentItemTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

A custom DataTemplateSelector object that provides logic and returns a DataTemplate. The default value is null.

Documents

Gets the collection of DockingWindow controls that are currently open in the MDI area.

public ReadOnlyDockingWindowCollection Documents { get; }

Property Value

ReadOnlyDockingWindowCollection:

The collection of DockingWindow controls that are currently open in the MDI area.

DocumentWindows

Gets the DocumentWindowCollection of document windows that are currently registered with the DockSite.

public DocumentWindowCollection DocumentWindows { get; }

Property Value

DocumentWindowCollection:

The DocumentWindowCollection of document windows that are currently registered with the DockSite.

FloatingDockHosts

Gets the collection of floating dock hosts, which are those that are top-level and external to the DockSite hierarchy's primary dock host.

public ReadOnlyObservableCollection<DockHost> FloatingDockHosts { get; }

Property Value

ReadOnlyObservableCollection<DockHost>:

The collection of floating dock hosts.

FloatingToolWindowContainersHaveMaximizeButtons

Gets or sets whether floating ToolWindowContainer controls can have title bar maximize buttons.

public bool FloatingToolWindowContainersHaveMaximizeButtons { get; set; }

Property Value

Boolean:

true if floating ToolWindowContainer controls can have title bar maximize buttons; otherwise, false. The default value is true.

Remarks

This property only affects non-hosted floating windows.

FloatingToolWindowContainersHaveMinimizeButtons

Gets or sets whether floating ToolWindowContainer controls can have title bar minimize buttons.

public bool FloatingToolWindowContainersHaveMinimizeButtons { get; set; }

Property Value

Boolean:

true if floating ToolWindowContainer controls can have title bar minimize buttons; otherwise, false. The default value is false.

Remarks

This property only affects non-hosted floating windows.

FloatingWindowIcon

Gets or sets the ImageSource for floating window icons, which should be set if document windows are allowed to float.

public ImageSource FloatingWindowIcon { get; set; }

Property Value

ImageSource:

The ImageSource for floating window icons.

Remarks

The value is generally the same as your application icon.

FloatingWindowShowInTaskBarMode

Gets or sets a mode that determines when to show floating windows in the taskbar.

public FloatingWindowShowInTaskBarMode FloatingWindowShowInTaskBarMode { get; set; }

Property Value

FloatingWindowShowInTaskBarMode:

A mode that determines when to show floating windows in the taskbar. The default value is FloatingWindowShowInTaskBarMode.Default.

Remarks

This feature only affects non-hosted floating windows.

FloatingWindowSnapToScreenThreshold

Gets or sets the minimum length of a floating window that must be visible over a screen's edge to avoid snap-to-screen.

public double FloatingWindowSnapToScreenThreshold { get; set; }

Property Value

Double:

The minimum length of a floating window that must be visible over a screen's edge to avoid snap-to-screen. The default value is 70.0.

Remarks

This feature is only used when the IsFloatingWindowSnapToScreenEnabled property is true. If a floating window is completely beyond the screen edge, it will be fully snapped back onto the screen. If a floating window is only partially beyond the screen edge, but the visible portion is less than this property's value, it will be snapped partially back onto the screen.

FloatingWindowTitle

Gets or sets the main title text for floating windows, which should be set if document windows are allowed to float.

[Localizability(LocalizationCategory.Title)]
public string FloatingWindowTitle { get; set; }

Property Value

String:

The main title text for floating windows.

Remarks

The value is generally the same as your application name.

See Also

FloatingWindowTitleDelimiter

Gets or sets the floating window title bar delimiter text placed between the primary document title and FloatingWindowTitle, applied as appropriate.

public string FloatingWindowTitleDelimiter { get; set; }

Property Value

String:

The floating window title bar delimiter text. The default value is " - ".

Remarks

This property is only used if there is a primary document in a floating window and FloatingWindowTitle is specified.

See Also

HasDocuments

Gets whether the DockSite currently has any open documents.

public bool HasDocuments { get; }

Property Value

Boolean:

true if the DockSite currently has any open documents; otherwise, false.

HostedFloatingWindowContainer

Gets or sets the FrameworkElement whose bounds should be used to restrict the movement of hosted floating windows. The FrameworkElement must be the DockSite or one of it's visual ancestors.

public FrameworkElement HostedFloatingWindowContainer { get; set; }

Property Value

FrameworkElement:

The FrameworkElement whose bounds should be used to restrict the movement of hosted floating windows; otherwise null which indicates to use the DockSite itself.

InactiveFloatingWindowFadeDelay

Gets or sets the duration in milliseconds of inactivity that must take place for a hosted floating window before it starts to fade out.

public double InactiveFloatingWindowFadeDelay { get; set; }

Property Value

Double:

The duration in milliseconds of inactivity that must take place for a hosted floating window before it starts to fade out. The default value is 20 seconds.

Remarks

The IsInactiveFloatingWindowFadeEnabled property must be set to true for this property to be used.

InactiveFloatingWindowFadeDuration

Gets or sets the duration in milliseconds over which an inactive hosted floating window will fade.

public double InactiveFloatingWindowFadeDuration { get; set; }

Property Value

Double:

The duration in milliseconds over which an inactive hosted floating window will fade. The default value is 20 seconds.

Remarks

The IsInactiveFloatingWindowFadeEnabled property must be set to true for this property to be used.

InactiveFloatingWindowFadeOpacity

Gets or sets the target opacity to which inactive hosted floating windows to fade.

public double InactiveFloatingWindowFadeOpacity { get; set; }

Property Value

Double:

The target opacity to which inactive hosted floating windows to fade. The default value is 0.25 (25% opacity).

Remarks

The IsInactiveFloatingWindowFadeEnabled property must be set to true for this property to be used.

IsDockGuideAnimationEnabled

Gets or sets whether dock guide animation is enabled.

public bool IsDockGuideAnimationEnabled { get; set; }

Property Value

Boolean:

true if dock guide animation is enabled; otherwise, false. The default value is true.

IsFloatingWindowSnapToScreenEnabled

Gets or sets whether floating windows are snapped onto the closest screen when displayed via a method other than being dragged.

public bool IsFloatingWindowSnapToScreenEnabled { get; set; }

Property Value

Boolean:

true if floating windows are snapped onto the closest screen when displayed via a method other than being dragged; otherwise, false. The default value is true.

Remarks

This feature ensures that floating windows are fully visible on-screen when being programmatically displayed, such as when a layout is loaded.

IsInactiveFloatingWindowFadeEnabled

Gets or sets whether hosted floating windows will fade out following inactivity.

public bool IsInactiveFloatingWindowFadeEnabled { get; set; }

Property Value

Boolean:

true if hosted floating windows will fade out following inactivity; otherwise, false. The default value is true.

Remarks

This option only applied when hosted floating windows are in use.

IsLiveSplittingEnabled

Gets or sets whether live splitting of docking windows is enabled.

public bool IsLiveSplittingEnabled { get; set; }

Property Value

Boolean:

true if live splitting of docking windows is enabled; otherwise, false. The default value is true.

IsTabLayoutAnimationEnabled

Gets or sets whether animation effects are applied during tab layout, such as when tabs are added or removed.

public bool IsTabLayoutAnimationEnabled { get; set; }

Property Value

Boolean:

true if animation effects are applied during tab layout, such as when tabs are added or removed; otherwise, false. The default value is true.

LinkedDockSites

Gets the linked DockSites, to which registered docking windows can be docked into.

public IEnumerable<DockSite> LinkedDockSites { get; }

Property Value

IEnumerable<DockSite>:

The linked DockSites, to which registered docking windows can be docked into.

MagnetismGapDistance

Gets or sets the distance between windows that are snapped together via magnetism.

public double MagnetismGapDistance { get; set; }

Property Value

Double:

The distance between windows that are snapped together via magnetism. The default value is 1.

Remarks

If this value is greater than 0, there will be a gap between windows that are snapped together when magnetism is enabled by the MagnetismSnapDistance property.

MagnetismSnapDistance

Gets or sets the distance at which magnetism begins to snap windows being dragged.

public double MagnetismSnapDistance { get; set; }

Property Value

Double:

The distance at which magnetism begins to snap windows being dragged. The default value is 5.

Remarks

If this value is greater than 0, magnetism is enabled. Set it to 0 to disable magnetism. Magnetism tries to snap corners of a window being dragged to other window corners around it. Increase this property's value to increase the range over which the magnetism will work. Magnetism also takes effect when resizing via window borders.

MdiKind

Gets or sets the kind of MDI currently in use.

public MdiKind MdiKind { get; set; }

Property Value

MdiKind:

A MdiKind indicating the kind of MDI currently in use. The default value is None.

PrimaryDockHost

Gets the primary dock host, which is the one that is implicitly created within the DockSite's template.

public DockHost PrimaryDockHost { get; }

Property Value

DockHost:

The primary dock host.

PrimaryDocument

Gets the DockingWindow that currently is the primary document in the dock site.

public DockingWindow PrimaryDocument { get; }

Property Value

DockingWindow:

The DockingWindow that currently is the primary document in the dock site.

Remarks

The primary document is the same as ActiveWindow if the active window is a document. When the ActiveWindow is not a document, then the primary document is the open document that was last activated.

SetMdiKindCommand

Gets the ICommand that can set the MDI kind to the MdiKind enumeration value specified in the command parameter.

public ICommand SetMdiKindCommand { get; }

Property Value

ICommand:

The ICommand that can set the MDI kind to the MdiKind enumeration value specified in the command parameter.

SplitterSize

Gets or sets the size of splitters.

public double SplitterSize { get; set; }

Property Value

Double:

The size of splitters. The default value is 5.

Switcher

Gets or sets the SwitcherBase that will be used to provide Ctrl+Tab window switching capabilities.

public SwitcherBase Switcher { get; set; }

Property Value

SwitcherBase:

The SwitcherBase that will be used to provide Ctrl+Tab window switching capabilities.

TileDocumentsHorizontallyCommand

Gets the ICommand that can tile the open documents horizontally.

public ICommand TileDocumentsHorizontallyCommand { get; }

Property Value

ICommand:

The ICommand that can tile the open documents horizontally.

TileDocumentsVerticallyCommand

Gets the ICommand that can tile the open documents vertically.

public ICommand TileDocumentsVerticallyCommand { get; }

Property Value

ICommand:

The ICommand that can tile the open documents vertically.

ToolItemContainerStyle

Gets or sets the Style that is applied to the container DockingWindow generated for each tool item.

public Style ToolItemContainerStyle { get; set; }

Property Value

Style:

The Style that is applied to the container DockingWindow generated for each tool item. The default value is null.

ToolItemContainerStyleSelector

Gets or sets custom style-selection logic for a style that can be applied to each generated container DockingWindow.

public StyleSelector ToolItemContainerStyleSelector { get; set; }

Property Value

StyleSelector:

A StyleSelector object that contains logic that chooses the style to use as the ToolItemContainerStyle. The default value is null.

ToolItemsSource

Gets or sets a collection used to generate tool windows for use in the DockSite.

public IEnumerable ToolItemsSource { get; set; }

Property Value

IEnumerable:

A collection that is used to generate generate tool windows for use in the DockSite. The default value is null.

ToolItemTemplate

Gets or sets the DataTemplate used to display each tool item.

public DataTemplate ToolItemTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that specifies the visualization of the data objects. The default value is null.

ToolItemTemplateSelector

Gets or sets the custom logic for choosing a template used to display each tool item.

public DataTemplateSelector ToolItemTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

A custom DataTemplateSelector object that provides logic and returns a DataTemplate. The default value is null.

ToolWindows

Gets the ToolWindowCollection of tool windows that are currently registered with the DockSite.

public ToolWindowCollection ToolWindows { get; }

Property Value

ToolWindowCollection:

The ToolWindowCollection of tool windows that are currently registered with the DockSite.

ToolWindowsHaveCloseButtons

Gets or sets whether ToolWindowContainer controls can have title bar close buttons.

public bool ToolWindowsHaveCloseButtons { get; set; }

Property Value

Boolean:

true if ToolWindowContainer controls can have title bar close buttons; otherwise, false. The default value is true.

ToolWindowsHaveOptionsButtons

Gets or sets whether ToolWindowContainer controls can have title bar options buttons.

public bool ToolWindowsHaveOptionsButtons { get; set; }

Property Value

Boolean:

true if ToolWindowContainer controls can have title bar options buttons; otherwise, false. The default value is true.

ToolWindowsHaveTabImages

Gets or sets the global setting for whether tool windows have images on tabs.

public bool ToolWindowsHaveTabImages { get; set; }

Property Value

Boolean:

true if tool windows have images on tabs; otherwise, false. The default value is false.

Remarks

This setting does not affect tabbed MDI, since TabbedMdiHost has its own HasTabImages property.

ToolWindowsHaveTitleBarIcons

Gets or sets the global setting for whether tool window title bars display the icon of the selected tool window.

public bool ToolWindowsHaveTitleBarIcons { get; set; }

Property Value

Boolean:

true if tool window title bars display the icon of the selected tool window; otherwise, false. The default value is false.

ToolWindowsHaveTitleBars

Gets or sets the global setting for whether tool windows display a title bar when not in MDI.

public bool ToolWindowsHaveTitleBars { get; set; }

Property Value

Boolean:

true if tool windows display a title bar when not in MDI; otherwise, false. The default value is true.

Remarks

This setting only affects tool windows whose HasTitleBar property is set to null. Any other setting on the tool window instance overrides this global setting.

ToolWindowsHaveToggleAutoHideButtons

Gets or sets whether ToolWindowContainer controls can have title bar toggle auto-hide buttons.

public bool ToolWindowsHaveToggleAutoHideButtons { get; set; }

Property Value

Boolean:

true if ToolWindowContainer controls can have title bar toggle auto-hide buttons; otherwise, false. The default value is true.

ToolWindowsSingleTabLayoutBehavior

Gets or sets the global setting for the behavior used when a single tool window is in a container.

public SingleTabLayoutBehavior ToolWindowsSingleTabLayoutBehavior { get; set; }

Property Value

SingleTabLayoutBehavior:

The behavior used when a single tool window is in a container. The default value is SingleTabLayoutBehavior.Hide.

ToolWindowsTabOverflowBehavior

Gets or sets the global setting for the overflow behavior of the tool window tabs.

public TabOverflowBehavior ToolWindowsTabOverflowBehavior { get; set; }

Property Value

TabOverflowBehavior:

The overflow behavior of the tool window tabs. The default value is TabOverflowBehavior.Shrink.

ToolWindowsTabStripPlacement

Gets or sets a Side indicating the side upon which the tool window tabs are located.

public Side ToolWindowsTabStripPlacement { get; set; }

Property Value

Side:

A Side indicating the side upon which the tool window tabs are located. The default value is Bottom.

ToolWindowsTitleBarContextContentAlignment

Gets or sets the alignment of tool window container title bar context content.

public ContextContentAlignment ToolWindowsTitleBarContextContentAlignment { get; set; }

Property Value

ContextContentAlignment:

The alignment of tool window container title bar context content. The default value is Far.

ToolWindowTabItemContainerStyle

Gets or sets the Style to use for rendering the tab item containers in a ToolWindowContainer.

public Style ToolWindowTabItemContainerStyle { get; set; }

Property Value

Style:

The Style to use for rendering the tab item containers in a ToolWindowContainer.

UseDragFloatPreviews

Gets or sets whether to use float previews when dragging windows instead of instantly creating floating windows.

public bool UseDragFloatPreviews { get; set; }

Property Value

Boolean:

true if float previews should be used when dragging windows instead of instantly creating floating windows; otherwise, false. The default value is false.

Remarks

This property should be set to true when docking window content contains a large number of elements that may not measure/arrange quickly. When this property is true, fewer layout cycles occur since a float preview is used to show where the floating window will be created instead of instantly moving the dragged windows into a floating window.

UseHostedFloatingWindows

Gets or sets whether floating windows should be hosted within the bounds of the dock site.

public bool UseHostedFloatingWindows { get; set; }

Property Value

Boolean:

true if floating windows should be hosted within the bounds of the dock site; otherwise, false. The default value is false.

Remarks

Due to security restrictions with the Window class in XBAPs, when used in an XBAP, a value of true will be forced.

UseHostedPopups

Gets or sets whether popups should be hosted within the bounds of the dock site.

public bool UseHostedPopups { get; set; }

Property Value

Boolean:

true if popups should be hosted within the bounds of the dock site; otherwise, false. The default value is true.

Remarks

This property should be false only in Windows applications where you expect to host interop (Windows Forms, DirectX, etc.) controls. If you do not plan on hosting interop controls, leave it true.

Methods

ActivateNextDocument()

Activates the next document by selecting it and focusing its content.

public void ActivateNextDocument()

ActivateNextTab()

Activates the next tab in the same container by selecting it and focusing its content.

public void ActivateNextTab()

ActivatePreviousDocument()

Activates the previous document by selecting it and focusing its content.

public void ActivatePreviousDocument()

ActivatePreviousTab()

Activates the previous tab in the same container by selecting it and focusing its content.

public void ActivatePreviousTab()

ActivatePrimaryDocument()

Activates the primary document by focusing its content.

public void ActivatePrimaryDocument()

ApplyContainerStyle(Object, DockingWindow, StyleSelector, Style)

Applies the style of the specified container window.

public static void ApplyContainerStyle(object item, DockingWindow container, StyleSelector styleSelector, Style style)
Parameter Type Description
item Object

The data item.

container DockingWindow

The container window whose style should be set.

styleSelector StyleSelector

The option style selector.

style Style

The desired specific style.

CascadeDocuments()

Cascades all open documents, if using tabbed or standard MDI.

public void CascadeDocuments()

ClearContainerForItemOverride(DockingWindow, Object, DockingWindowItemKind)

When overridden in a derived class, undoes the effects of the PrepareContainerForItemOverride(DockingWindow, Object, DockingWindowItemKind) method.

protected virtual void ClearContainerForItemOverride(DockingWindow container, object item, DockingWindowItemKind kind)
Parameter Type Description
container DockingWindow

The container DockingWindow.

item Object

The item.

kind DockingWindowItemKind

The kind of the item.

CloseAllDocuments()

Closes all open documents.

public bool CloseAllDocuments()

Returns

Boolean:

true if all open documents were closed; otherwise, false.

Remarks

Only documents that are closable are closed.

ClosePrimaryDocument()

Closes the primary document.

public bool ClosePrimaryDocument()

Returns

Boolean:

true if the primary document was closed; otherwise, false.

ContainerFromDocumentItem(Object)

Returns the DocumentWindow corresponding to the given item contained in DocumentItemsSource.

public DocumentWindow ContainerFromDocumentItem(object item)
Parameter Type Description
item Object

The Object item to find the DocumentWindow for.

Returns

DocumentWindow:

A DocumentWindow that corresponds to the given item; otherwise, null indicates the item does not belong to the item collection.

ContainerFromItem(Object)

Returns the DockingWindow corresponding to the given item contained in DocumentItemsSource or ToolItemsSource.

public DockingWindow ContainerFromItem(object item)
Parameter Type Description
item Object

The Object item to find the DockingWindow for.

Returns

DockingWindow:

A DockingWindow that corresponds to the given item; otherwise, null indicates the item does not belong to either item collection.

ContainerFromToolItem(Object)

Returns the ToolWindow corresponding to the given item contained in ToolItemsSource.

public ToolWindow ContainerFromToolItem(object item)
Parameter Type Description
item Object

The Object item to find the ToolWindow for.

Returns

ToolWindow:

A ToolWindow that corresponds to the given item; otherwise, null indicates the item does not belong to the item collection.

DockSiteRegistryConstructor()

Initializes a new instance of the DockSite class.

public void DockSiteRegistryConstructor()

GetContainerForItemOverride(DockingWindowItemKind)

Creates or identifies the DockingWindow that is used to display the given item.

protected virtual DockingWindow GetContainerForItemOverride(DockingWindowItemKind kind)
Parameter Type Description
kind DockingWindowItemKind

The kind of the item.

Returns

DockingWindow:

The DockingWindow that is used to display the given item.

GetFloatingDockHostTitle(DockHost)

Returns the title bar text to use for the specified floating DockHost.

protected virtual string GetFloatingDockHostTitle(DockHost dockHost)
Parameter Type Description
dockHost DockHost

The DockHost to examine.

Returns

String:

The title bar text to use for the specified floating DockHost.

Remarks

The default implementation of this method combines the dockHost.MdiHost.PrimaryWindow.Title (if there is a primary document in the DockHost), FloatingWindowTitleDelimiter, and FloatingWindowTitle values appropriately. An example result is "Document1.txt - MyApp".

See Also

InitializeAutoHidePopupWindow(Window)

Initializes a Window that contains an auto-hide popup.

protected virtual void InitializeAutoHidePopupWindow(Window window)
Parameter Type Description
window Window

The Window to initialize.

InitializeDockingAdornmentWindow(Window)

Initializes a Window that can host dock guide and dock preview adornments during a docking operation.

protected virtual void InitializeDockingAdornmentWindow(Window window)
Parameter Type Description
window Window

The Window to initialize.

InitializeFloatingWindow(Window)

Initializes a Window that contains a floating DockHost.

protected virtual void InitializeFloatingWindow(Window window)
Parameter Type Description
window Window

The Window to initialize.

IsItemItsOwnContainerOverride(Object, DockingWindowItemKind)

Determines if the specified item is (or is eligible to be) its own container.

protected virtual bool IsItemItsOwnContainerOverride(object item, DockingWindowItemKind kind)
Parameter Type Description
item Object

The item to check.

kind DockingWindowItemKind

The kind of the item.

Returns

Boolean:

true if the item is (or is eligible to be) its own container; otherwise, false.

LinkDockSite(DockSite)

Links this DockSite to the specified DockSite and vice versa, allowing docking windows to be seamlessly moved between the dock sites.

public void LinkDockSite(DockSite dockSite)
Parameter Type Description
dockSite DockSite

The DockSite to link.

Remarks

This method will completely link this DockSite to the specified DockSite. There is no need to call LinkDockSite(DockSite) on both DockSites.

OnApplyTemplate()

Invoked whenever application code or internal processes call ApplyTemplate.

public override void OnApplyTemplate()

OnCreateAutomationPeer()

Returns an AutomationPeer object for this control instance.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

An AutomationPeer instance.

OnDocumentItemsSourceChanged(IEnumerable, IEnumerable)

Called when the DocumentItemsSource property changes.

protected virtual void OnDocumentItemsSourceChanged(IEnumerable oldValue, IEnumerable newValue)
Parameter Type Description
oldValue IEnumerable

Old value of the DocumentItemsSource property.

newValue IEnumerable

New value of the DocumentItemsSource property.

OnFloatingWindowOpening(FloatingWindowOpeningEventArgs)

Occurs when a floating window is opening, allowing for customization before it is displayed.

protected virtual void OnFloatingWindowOpening(FloatingWindowOpeningEventArgs e)
Parameter Type Description
e FloatingWindowOpeningEventArgs

The FloatingWindowOpeningEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)

Occurs when a control within this control's hierarchy gains keyboard focus.

protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)
Parameter Type Description
e KeyboardFocusChangedEventArgs

The KeyboardFocusChangedEventArgs that contains data related to this event.

OnInitialized(EventArgs)

Occurs when the control is initialized.

protected override void OnInitialized(EventArgs e)
Parameter Type Description
e EventArgs

OnMdiKindChanged(RoutedEventArgs)

Occurs when the MdiKind property is changed.

protected virtual void OnMdiKindChanged(RoutedEventArgs e)
Parameter Type Description
e RoutedEventArgs

The RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnMenuOpening(DockingMenuEventArgs)

Occurs when a docking-related context menu is opening, allowing for customization before it is displayed.

protected virtual void OnMenuOpening(DockingMenuEventArgs e)
Parameter Type Description
e DockingMenuEventArgs

The DockingMenuEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnNewWindowRequested(RoutedEventArgs)

Occurs when a new DockingWindow is requested, generally via a user click on a new tab button.

protected virtual void OnNewWindowRequested(RoutedEventArgs e)
Parameter Type Description
e RoutedEventArgs

The RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnPrimaryDocumentChanged(DockingWindowEventArgs)

Occurs when the PrimaryDocument property has changed.

protected virtual void OnPrimaryDocumentChanged(DockingWindowEventArgs e)
Parameter Type Description
e DockingWindowEventArgs

The DockingWindowEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Occurs when a property is changed.

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameter Type Description
e DependencyPropertyChangedEventArgs

A DependencyPropertyChangedEventArgs that contains the event data.

OnToolItemsSourceChanged(IEnumerable, IEnumerable)

Called when the ToolItemsSource property changes.

protected virtual void OnToolItemsSourceChanged(IEnumerable oldValue, IEnumerable newValue)
Parameter Type Description
oldValue IEnumerable

Old value of the ToolItemsSource property.

newValue IEnumerable

New value of the ToolItemsSource property.

OnWindowActivated(DockingWindowEventArgs)

Occurs after a DockingWindow has been activated.

protected virtual void OnWindowActivated(DockingWindowEventArgs e)
Parameter Type Description
e DockingWindowEventArgs

The DockingWindowEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowAutoHidePopupClosed(DockingWindowEventArgs)

Occurs after an auto-hide popup has been closed that displayed a ToolWindow.

protected virtual void OnWindowAutoHidePopupClosed(DockingWindowEventArgs e)
Parameter Type Description
e DockingWindowEventArgs

The DockingWindowEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowAutoHidePopupOpened(DockingWindowEventArgs)

Occurs after an auto-hide popup has been opened that displays a ToolWindow.

protected virtual void OnWindowAutoHidePopupOpened(DockingWindowEventArgs e)
Parameter Type Description
e DockingWindowEventArgs

The DockingWindowEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowDeactivated(DockingWindowEventArgs)

Occurs after a DockingWindow has been deactivated.

protected virtual void OnWindowDeactivated(DockingWindowEventArgs e)
Parameter Type Description
e DockingWindowEventArgs

The DockingWindowEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowDefaultLocationRequested(DockingWindowDefaultLocationEventArgs)

Occurs when a DockingWindow's default location is requested.

protected virtual void OnWindowDefaultLocationRequested(DockingWindowDefaultLocationEventArgs e)
Parameter Type Description
e DockingWindowDefaultLocationEventArgs

The DockingWindowDefaultLocationEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowRegistered(DockingWindowEventArgs)

Occurs after a DockingWindow has been registered.

protected virtual void OnWindowRegistered(DockingWindowEventArgs e)
Parameter Type Description
e DockingWindowEventArgs

The DockingWindowEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowsAutoHiding(DockingWindowsAutoHidingEventArgs)

Occurs before one or more DockingWindow controls are auto-hidden, allowing for side customization.

protected virtual void OnWindowsAutoHiding(DockingWindowsAutoHidingEventArgs e)
Parameter Type Description
e DockingWindowsAutoHidingEventArgs

The DockingWindowsAutoHidingEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowsClosed(DockingWindowsEventArgs)

Occurs after one or more DockingWindow controls have been closed.

protected virtual void OnWindowsClosed(DockingWindowsEventArgs e)
Parameter Type Description
e DockingWindowsEventArgs

The DockingWindowsEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowsClosing(DockingWindowsEventArgs)

Occurs before one or more DockingWindow controls are closed, allowing for cancellation of the close.

protected virtual void OnWindowsClosing(DockingWindowsEventArgs e)
Parameter Type Description
e DockingWindowsEventArgs

The DockingWindowsEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowsDockHostChanged(DockingWindowsEventArgs)

Occurs after one or more DockingWindow controls' DockHost properties have changed.

protected virtual void OnWindowsDockHostChanged(DockingWindowsEventArgs e)
Parameter Type Description
e DockingWindowsEventArgs

The DockingWindowsEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowsDragged(DockingWindowsEventArgs)

Occurs after one or more DockingWindow controls are dragged by the end user.

protected virtual void OnWindowsDragged(DockingWindowsEventArgs e)
Parameter Type Description
e DockingWindowsEventArgs

The DockingWindowsEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowsDragging(DockingWindowsEventArgs)

Occurs before one or more DockingWindow controls are dragged by the end user.

protected virtual void OnWindowsDragging(DockingWindowsEventArgs e)
Parameter Type Description
e DockingWindowsEventArgs

The DockingWindowsEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowsDragOver(DockingWindowsDragOverEventArgs)

Occurs when one or more docking windows are dragged over a new dock target, allowing for certain dock guides to be hidden.

protected virtual void OnWindowsDragOver(DockingWindowsDragOverEventArgs e)
Parameter Type Description
e DockingWindowsDragOverEventArgs

The DockingWindowsDragOverEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowsOpened(DockingWindowsEventArgs)

Occurs after one or more DockingWindow controls have been opened.

protected virtual void OnWindowsOpened(DockingWindowsEventArgs e)
Parameter Type Description
e DockingWindowsEventArgs

The DockingWindowsEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowsOpening(DockingWindowsEventArgs)

Occurs before one or more DockingWindow controls is opened.

protected virtual void OnWindowsOpening(DockingWindowsEventArgs e)
Parameter Type Description
e DockingWindowsEventArgs

The DockingWindowsEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowsStateChanged(DockingWindowsEventArgs)

Occurs after one or more DockingWindow controls' states have changed.

protected virtual void OnWindowsStateChanged(DockingWindowsEventArgs e)
Parameter Type Description
e DockingWindowsEventArgs

The DockingWindowsEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

OnWindowUnregistered(DockingWindowEventArgs)

Occurs after a DockingWindow has been unregistered.

protected virtual void OnWindowUnregistered(DockingWindowEventArgs e)
Parameter Type Description
e DockingWindowEventArgs

The DockingWindowEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

PrepareContainerForItemOverride(DockingWindow, Object, DockingWindowItemKind)

Prepares the specified DockingWindow to display the specified item.

protected virtual void PrepareContainerForItemOverride(DockingWindow container, object item, DockingWindowItemKind kind)
Parameter Type Description
container DockingWindow

The DockingWindow used to display the specified item.

item Object

The item.

kind DockingWindowItemKind

The kind of the item.

ProcessDockHostKeyDown(DockHost, KeyEventArgs)

Processes a key down event from a dock host.

protected virtual void ProcessDockHostKeyDown(DockHost dockHost, KeyEventArgs e)
Parameter Type Description
dockHost DockHost

The DockHost requesting processing.

e KeyEventArgs

The KeyEventArgs that contains the event data.

TileDocumentsHorizontally()

Tiles all open documents horizontally, if using tabbed or standard MDI.

public void TileDocumentsHorizontally()

TileDocumentsVertically()

Tiles all open documents vertically, if using tabbed or standard MDI.

public void TileDocumentsVertically()

ToHierarchyString()

Creates a string that contains a textual representation of the dock site hierarchy, useful for debugging purposes.

public string ToHierarchyString()

Returns

String:

The string that was created.

UnlinkDockSite(DockSite)

Unlinks this DockSite from the specified DockSite and vice versa.

public void UnlinkDockSite(DockSite dockSite)
Parameter Type Description
dockSite DockSite

The DockSite to unlink.

Remarks

This method will completely unlink this DockSite from the specified DockSite. There is no need to call UnlinkDockSite(DockSite) on both DockSites.

Events

FloatingWindowOpening

Occurs when a floating window is opening, allowing for customization before it is displayed.

public event EventHandler<FloatingWindowOpeningEventArgs> FloatingWindowOpening

Event Type

EventHandler<FloatingWindowOpeningEventArgs>

MdiKindChanged

Occurs when the MdiKind property is changed.

public event RoutedEventHandler MdiKindChanged

Event Type

RoutedEventHandler

MenuOpening

Occurs when a docking-related context menu is opening, allowing for customization before it is displayed.

public event EventHandler<DockingMenuEventArgs> MenuOpening

Event Type

EventHandler<DockingMenuEventArgs>

NewWindowRequested

Occurs when a new DockingWindow is requested, generally via a user click on a new tab button.

public event RoutedEventHandler NewWindowRequested

Event Type

RoutedEventHandler

PrimaryDocumentChanged

Occurs when the PrimaryDocument property has changed.

public event EventHandler<DockingWindowEventArgs> PrimaryDocumentChanged

Event Type

EventHandler<DockingWindowEventArgs>

WindowActivated

Occurs after a DockingWindow has been activated.

public event EventHandler<DockingWindowEventArgs> WindowActivated

Event Type

EventHandler<DockingWindowEventArgs>

WindowAutoHidePopupClosed

Occurs after an auto-hide popup has been closed that displayed a ToolWindow.

public event EventHandler<DockingWindowEventArgs> WindowAutoHidePopupClosed

Event Type

EventHandler<DockingWindowEventArgs>

WindowAutoHidePopupOpened

Occurs after an auto-hide popup has been opened that displays a ToolWindow.

public event EventHandler<DockingWindowEventArgs> WindowAutoHidePopupOpened

Event Type

EventHandler<DockingWindowEventArgs>

WindowDeactivated

Occurs after a DockingWindow has been deactivated.

public event EventHandler<DockingWindowEventArgs> WindowDeactivated

Event Type

EventHandler<DockingWindowEventArgs>

WindowDefaultLocationRequested

Occurs when a DockingWindow's default location is requested.

public event EventHandler<DockingWindowDefaultLocationEventArgs> WindowDefaultLocationRequested

Event Type

EventHandler<DockingWindowDefaultLocationEventArgs>

Remarks

The handler should examine the event arguments and set the Target and/or Side properties as appropriate.

WindowRegistered

Occurs after a DockingWindow has been registered.

public event EventHandler<DockingWindowEventArgs> WindowRegistered

Event Type

EventHandler<DockingWindowEventArgs>

WindowsAutoHiding

Occurs before one or more DockingWindow controls are auto-hidden, allowing for side customization.

public event EventHandler<DockingWindowsAutoHidingEventArgs> WindowsAutoHiding

Event Type

EventHandler<DockingWindowsAutoHidingEventArgs>

WindowsClosed

Occurs after one or more DockingWindow controls have been closed.

public event EventHandler<DockingWindowsEventArgs> WindowsClosed

Event Type

EventHandler<DockingWindowsEventArgs>

WindowsClosing

Occurs before one or more DockingWindow controls are closed, allowing for cancellation of the close.

public event EventHandler<DockingWindowsEventArgs> WindowsClosing

Event Type

EventHandler<DockingWindowsEventArgs>

WindowsDockHostChanged

Occurs after one or more DockingWindow controls' DockHost properties have changed.

public event EventHandler<DockingWindowsEventArgs> WindowsDockHostChanged

Event Type

EventHandler<DockingWindowsEventArgs>

WindowsDragged

Occurs after one or more DockingWindow controls are dragged by the end user.

public event EventHandler<DockingWindowsEventArgs> WindowsDragged

Event Type

EventHandler<DockingWindowsEventArgs>

WindowsDragging

Occurs before one or more DockingWindow controls are dragged by the end user.

public event EventHandler<DockingWindowsEventArgs> WindowsDragging

Event Type

EventHandler<DockingWindowsEventArgs>

WindowsDragOver

Occurs when one or more docking windows are dragged over a new dock target, allowing for certain dock guides to be hidden.

public event EventHandler<DockingWindowsDragOverEventArgs> WindowsDragOver

Event Type

EventHandler<DockingWindowsDragOverEventArgs>

WindowsOpened

Occurs after one or more DockingWindow controls have been opened.

public event EventHandler<DockingWindowsEventArgs> WindowsOpened

Event Type

EventHandler<DockingWindowsEventArgs>

WindowsOpening

Occurs before one or more DockingWindow controls is opened.

public event EventHandler<DockingWindowsEventArgs> WindowsOpening

Event Type

EventHandler<DockingWindowsEventArgs>

WindowsStateChanged

Occurs after one or more DockingWindow controls' states have changed.

public event EventHandler<DockingWindowsEventArgs> WindowsStateChanged

Event Type

EventHandler<DockingWindowsEventArgs>

WindowUnregistered

Occurs after a DockingWindow has been unregistered.

public event EventHandler<DockingWindowEventArgs> WindowUnregistered

Event Type

EventHandler<DockingWindowEventArgs>

Explicit Interface Implementations

IDockTarget.DockHost

Gets the owner DockHost.

DockHost IDockTarget.DockHost { get; }

Returns

DockHost:

The owner DockHost.

IDockTarget.DockSite

Gets the DockSite that is managing this container.

DockSite IDockTarget.DockSite { get; }

Returns

DockSite:

The DockSite that is managing this container.

IDockTarget.GetState(Nullable<Side>)

Returns the DockingWindowState that specifies the state of the docking location around the target.

DockingWindowState IDockTarget.GetState(Side? side)
Parameter Type Description
side Nullable<Side>

Returns

DockingWindowState:

The DockingWindowState that specifies the state of the docking location around the target.

Fields

ActiveWindowProperty

Identifies the ActiveWindow dependency property. This field is read-only.

public static readonly DependencyProperty ActiveWindowProperty

AreDocumentWindowsDestroyedOnCloseProperty

Identifies the AreDocumentWindowsDestroyedOnClose dependency property. This field is read-only.

public static readonly DependencyProperty AreDocumentWindowsDestroyedOnCloseProperty

AreNewTabsInsertedBeforeExistingTabsProperty

Identifies the AreNewTabsInsertedBeforeExistingTabs dependency property. This field is read-only.

public static readonly DependencyProperty AreNewTabsInsertedBeforeExistingTabsProperty

AutoHidePerContainerProperty

Identifies the AutoHidePerContainer dependency property. This field is read-only.

public static readonly DependencyProperty AutoHidePerContainerProperty

AutoHidePopupCloseAnimationDurationProperty

Identifies the AutoHidePopupCloseAnimationDuration dependency property. This field is read-only.

public static readonly DependencyProperty AutoHidePopupCloseAnimationDurationProperty

AutoHidePopupCloseDelayProperty

Identifies the AutoHidePopupCloseDelay dependency property. This field is read-only.

public static readonly DependencyProperty AutoHidePopupCloseDelayProperty

AutoHidePopupClosesOnLostFocusProperty

Identifies the AutoHidePopupClosesOnLostFocus dependency property. This field is read-only.

public static readonly DependencyProperty AutoHidePopupClosesOnLostFocusProperty

AutoHidePopupOpenAnimationDurationProperty

Identifies the AutoHidePopupOpenAnimationDuration dependency property. This field is read-only.

public static readonly DependencyProperty AutoHidePopupOpenAnimationDurationProperty

AutoHidePopupOpenDelayProperty

Identifies the AutoHidePopupOpenDelay dependency property. This field is read-only.

public static readonly DependencyProperty AutoHidePopupOpenDelayProperty

AutoHidePopupOpensOnMouseHoverProperty

Identifies the AutoHidePopupOpensOnMouseHover dependency property. This field is read-only.

public static readonly DependencyProperty AutoHidePopupOpensOnMouseHoverProperty

AutoHideTabItemTemplateProperty

Identifies the AutoHideTabItemTemplate dependency property. This field is read-only.

public static readonly DependencyProperty AutoHideTabItemTemplateProperty

AutoHideTabItemTemplateSelectorProperty

Identifies the AutoHideTabItemTemplateSelector dependency property. This field is read-only.

public static readonly DependencyProperty AutoHideTabItemTemplateSelectorProperty

CanDocumentWindowsCloseProperty

Identifies the CanDocumentWindowsClose dependency property. This field is read-only.

public static readonly DependencyProperty CanDocumentWindowsCloseProperty

CanDocumentWindowsDragToLinkedDockSitesProperty

Identifies the CanDocumentWindowsDragToLinkedDockSites dependency property. This field is read-only.

public static readonly DependencyProperty CanDocumentWindowsDragToLinkedDockSitesProperty

CanDocumentWindowsFloatProperty

Identifies the CanDocumentWindowsFloat dependency property. This field is read-only.

public static readonly DependencyProperty CanDocumentWindowsFloatProperty

CanFloatingDockHostsHideOnDockSiteUnloadProperty

Identifies the CanFloatingDockHostsHideOnDockSiteUnload dependency property. This field is read-only.

public static readonly DependencyProperty CanFloatingDockHostsHideOnDockSiteUnloadProperty

CanToolWindowsAttachProperty

Identifies the CanToolWindowsAttach dependency property. This field is read-only.

public static readonly DependencyProperty CanToolWindowsAttachProperty

CanToolWindowsAutoHideProperty

Identifies the CanToolWindowsAutoHide dependency property. This field is read-only.

public static readonly DependencyProperty CanToolWindowsAutoHideProperty

CanToolWindowsBecomeDocumentsProperty

Identifies the CanToolWindowsBecomeDocuments dependency property. This field is read-only.

public static readonly DependencyProperty CanToolWindowsBecomeDocumentsProperty

CanToolWindowsCloseOnMiddleClickProperty

Identifies the CanToolWindowsCloseOnMiddleClick dependency property. This field is read-only.

public static readonly DependencyProperty CanToolWindowsCloseOnMiddleClickProperty

CanToolWindowsCloseProperty

Identifies the CanToolWindowsClose dependency property. This field is read-only.

public static readonly DependencyProperty CanToolWindowsCloseProperty

CanToolWindowsDockProperty

Identifies the CanToolWindowsDock dependency property. This field is read-only.

public static readonly DependencyProperty CanToolWindowsDockProperty

CanToolWindowsDragToFloatingDockHostsWithWorkspacesProperty

Identifies the CanToolWindowsDragToFloatingDockHostsWithWorkspaces dependency property. This field is read-only.

public static readonly DependencyProperty CanToolWindowsDragToFloatingDockHostsWithWorkspacesProperty

CanToolWindowsDragToLinkedDockSitesProperty

Identifies the CanToolWindowsDragToLinkedDockSites dependency property. This field is read-only.

public static readonly DependencyProperty CanToolWindowsDragToLinkedDockSitesProperty

CanToolWindowsFloatProperty

Identifies the CanToolWindowsFloat dependency property. This field is read-only.

public static readonly DependencyProperty CanToolWindowsFloatProperty

CanToolWindowTabsDragProperty

Identifies the CanToolWindowTabsDrag dependency property. This field is read-only.

public static readonly DependencyProperty CanToolWindowTabsDragProperty

CanUpdateItemsSourceOnUnregisterProperty

Identifies the CanUpdateItemsSourceOnUnregister dependency property. This field is read-only.

public static readonly DependencyProperty CanUpdateItemsSourceOnUnregisterProperty

ChildProperty

Identifies the Child dependency property. This field is read-only.

public static readonly DependencyProperty ChildProperty

ClosePerContainerProperty

Identifies the ClosePerContainer dependency property. This field is read-only.

public static readonly DependencyProperty ClosePerContainerProperty

DocumentItemContainerStyleProperty

Identifies the DocumentItemContainerStyle dependency property. This field is read-only.

public static readonly DependencyProperty DocumentItemContainerStyleProperty

DocumentItemContainerStyleSelectorProperty

Identifies the DocumentItemContainerStyleSelector dependency property. This field is read-only.

public static readonly DependencyProperty DocumentItemContainerStyleSelectorProperty

DocumentItemsSourceProperty

Identifies the DocumentItemsSource dependency property. This field is read-only.

public static readonly DependencyProperty DocumentItemsSourceProperty

DocumentItemTemplateProperty

Identifies the DocumentItemTemplate dependency property. This field is read-only.

public static readonly DependencyProperty DocumentItemTemplateProperty

DocumentItemTemplateSelectorProperty

Identifies the DocumentItemTemplateSelector dependency property. This field is read-only.

public static readonly DependencyProperty DocumentItemTemplateSelectorProperty

FloatingToolWindowContainersHaveMaximizeButtonsProperty

Identifies the FloatingToolWindowContainersHaveMaximizeButtons dependency property. This field is read-only.

public static readonly DependencyProperty FloatingToolWindowContainersHaveMaximizeButtonsProperty

FloatingToolWindowContainersHaveMinimizeButtonsProperty

Identifies the FloatingToolWindowContainersHaveMinimizeButtons dependency property. This field is read-only.

public static readonly DependencyProperty FloatingToolWindowContainersHaveMinimizeButtonsProperty

FloatingWindowIconProperty

Identifies the FloatingWindowIcon dependency property. This field is read-only.

public static readonly DependencyProperty FloatingWindowIconProperty

FloatingWindowOpeningEvent

Identifies the FloatingWindowOpening routed event. This field is read-only.

public static readonly RoutedEvent FloatingWindowOpeningEvent

FloatingWindowShowInTaskBarModeProperty

Identifies the FloatingWindowShowInTaskBarMode dependency property. This field is read-only.

public static readonly DependencyProperty FloatingWindowShowInTaskBarModeProperty

FloatingWindowSnapToScreenThresholdProperty

Identifies the FloatingWindowSnapToScreenThreshold dependency property. This field is read-only.

public static readonly DependencyProperty FloatingWindowSnapToScreenThresholdProperty

FloatingWindowTitleDelimiterProperty

Identifies the FloatingWindowTitleDelimiter dependency property. This field is read-only.

public static readonly DependencyProperty FloatingWindowTitleDelimiterProperty

FloatingWindowTitleProperty

Identifies the FloatingWindowTitle dependency property. This field is read-only.

public static readonly DependencyProperty FloatingWindowTitleProperty

HostedFloatingWindowContainerProperty

Identifies the HostedFloatingWindowContainer dependency property. This field is read-only.

public static readonly DependencyProperty HostedFloatingWindowContainerProperty

InactiveFloatingWindowFadeDelayProperty

Identifies the InactiveFloatingWindowFadeDelay dependency property. This field is read-only.

public static readonly DependencyProperty InactiveFloatingWindowFadeDelayProperty

InactiveFloatingWindowFadeDurationProperty

Identifies the InactiveFloatingWindowFadeDuration dependency property. This field is read-only.

public static readonly DependencyProperty InactiveFloatingWindowFadeDurationProperty

InactiveFloatingWindowFadeOpacityProperty

Identifies the InactiveFloatingWindowFadeOpacity dependency property. This field is read-only.

public static readonly DependencyProperty InactiveFloatingWindowFadeOpacityProperty

IsDockGuideAnimationEnabledProperty

Identifies the IsDockGuideAnimationEnabled dependency property. This field is read-only.

public static readonly DependencyProperty IsDockGuideAnimationEnabledProperty

IsFloatingWindowSnapToScreenEnabledProperty

Identifies the IsFloatingWindowSnapToScreenEnabled dependency property. This field is read-only.

public static readonly DependencyProperty IsFloatingWindowSnapToScreenEnabledProperty

IsInactiveFloatingWindowFadeEnabledProperty

Identifies the IsInactiveFloatingWindowFadeEnabled dependency property. This field is read-only.

public static readonly DependencyProperty IsInactiveFloatingWindowFadeEnabledProperty

IsLiveSplittingEnabledProperty

Identifies the IsLiveSplittingEnabled dependency property. This field is read-only.

public static readonly DependencyProperty IsLiveSplittingEnabledProperty

IsTabLayoutAnimationEnabledProperty

Identifies the IsTabLayoutAnimationEnabled dependency property. This field is read-only.

public static readonly DependencyProperty IsTabLayoutAnimationEnabledProperty

MagnetismGapDistanceProperty

Identifies the MagnetismGapDistance dependency property. This field is read-only.

public static readonly DependencyProperty MagnetismGapDistanceProperty

MagnetismSnapDistanceProperty

Identifies the MagnetismSnapDistance dependency property. This field is read-only.

public static readonly DependencyProperty MagnetismSnapDistanceProperty

MdiKindChangedEvent

Identifies the MdiKindChanged routed event. This field is read-only.

public static readonly RoutedEvent MdiKindChangedEvent

MdiKindProperty

Identifies the MdiKind dependency property. This field is read-only.

public static readonly DependencyProperty MdiKindProperty

MenuOpeningEvent

Identifies the MenuOpening routed event. This field is read-only.

public static readonly RoutedEvent MenuOpeningEvent

NewWindowRequestedEvent

Identifies the NewWindowRequested routed event. This field is read-only.

public static readonly RoutedEvent NewWindowRequestedEvent

PrimaryDocumentChangedEvent

Identifies the PrimaryDocumentChanged routed event. This field is read-only.

public static readonly RoutedEvent PrimaryDocumentChangedEvent

PrimaryDocumentProperty

Identifies the PrimaryDocument dependency property. This field is read-only.

public static readonly DependencyProperty PrimaryDocumentProperty

SplitterSizeProperty

Identifies the SplitterSize dependency property. This field is read-only.

public static readonly DependencyProperty SplitterSizeProperty

SwitcherProperty

Identifies the Switcher dependency property. This field is read-only.

public static readonly DependencyProperty SwitcherProperty

ToolItemContainerStyleProperty

Identifies the ToolItemContainerStyle dependency property. This field is read-only.

public static readonly DependencyProperty ToolItemContainerStyleProperty

ToolItemContainerStyleSelectorProperty

Identifies the ToolItemContainerStyleSelector dependency property. This field is read-only.

public static readonly DependencyProperty ToolItemContainerStyleSelectorProperty

ToolItemsSourceProperty

Identifies the ToolItemsSource dependency property. This field is read-only.

public static readonly DependencyProperty ToolItemsSourceProperty

ToolItemTemplateProperty

Identifies the ToolItemTemplate dependency property. This field is read-only.

public static readonly DependencyProperty ToolItemTemplateProperty

ToolItemTemplateSelectorProperty

Identifies the ToolItemTemplateSelector dependency property. This field is read-only.

public static readonly DependencyProperty ToolItemTemplateSelectorProperty

ToolWindowsHaveCloseButtonsProperty

Identifies the ToolWindowsHaveCloseButtons dependency property. This field is read-only.

public static readonly DependencyProperty ToolWindowsHaveCloseButtonsProperty

ToolWindowsHaveOptionsButtonsProperty

Identifies the ToolWindowsHaveOptionsButtons dependency property. This field is read-only.

public static readonly DependencyProperty ToolWindowsHaveOptionsButtonsProperty

ToolWindowsHaveTabImagesProperty

Identifies the ToolWindowsHaveTabImages dependency property. This field is read-only.

public static readonly DependencyProperty ToolWindowsHaveTabImagesProperty

ToolWindowsHaveTitleBarIconsProperty

Identifies the ToolWindowsHaveTitleBarIcons dependency property. This field is read-only.

public static readonly DependencyProperty ToolWindowsHaveTitleBarIconsProperty

ToolWindowsHaveTitleBarsProperty

Identifies the ToolWindowsHaveTitleBars dependency property. This field is read-only.

public static readonly DependencyProperty ToolWindowsHaveTitleBarsProperty

ToolWindowsHaveToggleAutoHideButtonsProperty

Identifies the ToolWindowsHaveToggleAutoHideButtons dependency property. This field is read-only.

public static readonly DependencyProperty ToolWindowsHaveToggleAutoHideButtonsProperty

ToolWindowsSingleTabLayoutBehaviorProperty

Identifies the ToolWindowsSingleTabLayoutBehavior dependency property. This field is read-only.

public static readonly DependencyProperty ToolWindowsSingleTabLayoutBehaviorProperty

ToolWindowsTabOverflowBehaviorProperty

Identifies the ToolWindowsTabOverflowBehavior dependency property. This field is read-only.

public static readonly DependencyProperty ToolWindowsTabOverflowBehaviorProperty

ToolWindowsTabStripPlacementProperty

Identifies the ToolWindowsTabStripPlacement dependency property. This field is read-only.

public static readonly DependencyProperty ToolWindowsTabStripPlacementProperty

ToolWindowsTitleBarContextContentAlignmentProperty

Identifies the ToolWindowsTitleBarContextContentAlignment dependency property. This field is read-only.

public static readonly DependencyProperty ToolWindowsTitleBarContextContentAlignmentProperty

ToolWindowTabItemContainerStyleProperty

Identifies the ToolWindowTabItemContainerStyle dependency property. This field is read-only.

public static readonly DependencyProperty ToolWindowTabItemContainerStyleProperty

UseDragFloatPreviewsProperty

Identifies the UseDragFloatPreviews dependency property. This field is read-only.

public static readonly DependencyProperty UseDragFloatPreviewsProperty

UseHostedFloatingWindowsProperty

Identifies the UseHostedFloatingWindows dependency property. This field is read-only.

public static readonly DependencyProperty UseHostedFloatingWindowsProperty

UseHostedPopupsProperty

Identifies the UseHostedPopups dependency property. This field is read-only.

public static readonly DependencyProperty UseHostedPopupsProperty

WindowActivatedEvent

Identifies the WindowActivated routed event. This field is read-only.

public static readonly RoutedEvent WindowActivatedEvent

WindowAutoHidePopupClosedEvent

Identifies the WindowAutoHidePopupClosed routed event. This field is read-only.

public static readonly RoutedEvent WindowAutoHidePopupClosedEvent

WindowAutoHidePopupOpenedEvent

Identifies the WindowAutoHidePopupOpened routed event. This field is read-only.

public static readonly RoutedEvent WindowAutoHidePopupOpenedEvent

WindowDeactivatedEvent

Identifies the WindowDeactivated routed event. This field is read-only.

public static readonly RoutedEvent WindowDeactivatedEvent

WindowDefaultLocationRequestedEvent

Identifies the WindowDefaultLocationRequested routed event. This field is read-only.

public static readonly RoutedEvent WindowDefaultLocationRequestedEvent

WindowRegisteredEvent

Identifies the WindowRegistered routed event. This field is read-only.

public static readonly RoutedEvent WindowRegisteredEvent

WindowsAutoHidingEvent

Identifies the WindowsAutoHiding routed event. This field is read-only.

public static readonly RoutedEvent WindowsAutoHidingEvent

WindowsClosedEvent

Identifies the WindowsClosed routed event. This field is read-only.

public static readonly RoutedEvent WindowsClosedEvent

WindowsClosingEvent

Identifies the WindowsClosing routed event. This field is read-only.

public static readonly RoutedEvent WindowsClosingEvent

WindowsDockHostChangedEvent

Identifies the WindowsDockHostChanged routed event. This field is read-only.

public static readonly RoutedEvent WindowsDockHostChangedEvent

WindowsDraggedEvent

Identifies the WindowsDragged routed event. This field is read-only.

public static readonly RoutedEvent WindowsDraggedEvent

WindowsDraggingEvent

Identifies the WindowsDragging routed event. This field is read-only.

public static readonly RoutedEvent WindowsDraggingEvent

WindowsDragOverEvent

Identifies the WindowsDragOver routed event. This field is read-only.

public static readonly RoutedEvent WindowsDragOverEvent

WindowsOpenedEvent

Identifies the WindowsOpened routed event. This field is read-only.

public static readonly RoutedEvent WindowsOpenedEvent

WindowsOpeningEvent

Identifies the WindowsOpening routed event. This field is read-only.

public static readonly RoutedEvent WindowsOpeningEvent

WindowsStateChangedEvent

Identifies the WindowsStateChanged routed event. This field is read-only.

public static readonly RoutedEvent WindowsStateChangedEvent

WindowUnregisteredEvent

Identifies the WindowUnregistered routed event. This field is read-only.

public static readonly RoutedEvent WindowUnregisteredEvent

Inherited Members

Extension Methods