DockSite Class

[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

public DockSite()

public ICommand ActivateNextDocumentCommand { get; }

Property Value

ICommand:

The ICommand that can activate the next document.

public ICommand ActivatePreviousDocumentCommand { get; }

Property Value

ICommand:

The ICommand that can activate the previous document.

public ICommand ActivatePrimaryDocumentCommand { get; }

Property Value

ICommand:

The ICommand that can activate the primary document.

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.

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.

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.

public ToolWindowContainerCollection AutoHideBottomContainers { get; }

Property Value

ToolWindowContainerCollection:

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

public ToolWindowContainerCollection AutoHideLeftContainers { get; }

Property Value

ToolWindowContainerCollection:

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

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.

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.

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.

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.

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.

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.

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.

public ToolWindowContainerCollection AutoHideRightContainers { get; }

Property Value

ToolWindowContainerCollection:

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

public DataTemplate AutoHideTabItemTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate 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.

public ToolWindowContainerCollection AutoHideTopContainers { get; }

Property Value

ToolWindowContainerCollection:

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

public ICommand CascadeDocumentsCommand { get; }

Property Value

ICommand:

The ICommand that can cascade the open documents.

public FrameworkElement Child { get; set; }

Property Value

FrameworkElement:

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

public ICommand CloseAllDocumentsCommand { get; }

Property Value

ICommand:

The ICommand that can close all open documents.

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.

public ICommand ClosePrimaryDocumentCommand { get; }

Property Value

ICommand:

The ICommand that can close the primary document.

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.

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.

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.

public DataTemplate DocumentItemTemplate { get; set; }

Property Value

DataTemplate:

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

public DataTemplateSelector DocumentItemTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

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

public ReadOnlyDockingWindowCollection Documents { get; }

Property Value

ReadOnlyDockingWindowCollection:

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

public DocumentWindowCollection DocumentWindows { get; }

Property Value

DocumentWindowCollection:

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

public ReadOnlyObservableCollection<DockHost> FloatingDockHosts { get; }

Property Value

ReadOnlyObservableCollection<DockHost>:

The collection of floating dock hosts.

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.

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.

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.

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.

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.

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

Property Value

String:

The title text for floating windows.

Remarks

The value is generally the same as your application name.

public bool HasDocuments { get; }

Property Value

Boolean:

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

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.

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.

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.

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.

public bool IsDockGuideAnimationEnabled { get; set; }

Property Value

Boolean:

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

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.

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.

public bool IsLiveSplittingEnabled { get; set; }

Property Value

Boolean:

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

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.

public IEnumerable<DockSite> LinkedDockSites { get; }

Property Value

IEnumerable<DockSite>:

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

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.

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.

public MdiKind MdiKind { get; set; }

Property Value

MdiKind:

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

public DockHost PrimaryDockHost { get; }

Property Value

DockHost:

The primary dock host.

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.

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.

public double SplitterSize { get; set; }

Property Value

Double:

The size of splitters. The default value is 5.

public SwitcherBase Switcher { get; set; }

Property Value

SwitcherBase:

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

public ICommand TileDocumentsHorizontallyCommand { get; }

Property Value

ICommand:

The ICommand that can tile the open documents horizontally.

public ICommand TileDocumentsVerticallyCommand { get; }

Property Value

ICommand:

The ICommand that can tile the open documents vertically.

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.

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.

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.

public DataTemplate ToolItemTemplate { get; set; }

Property Value

DataTemplate:

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

public DataTemplateSelector ToolItemTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

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

public ToolWindowCollection ToolWindows { get; }

Property Value

ToolWindowCollection:

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

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.

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.

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.

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.

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.

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.

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.

public TabOverflowBehavior ToolWindowsTabOverflowBehavior { get; set; }

Property Value

TabOverflowBehavior:

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

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.

public ContextContentAlignment ToolWindowsTitleBarContextContentAlignment { get; set; }

Property Value

ContextContentAlignment:

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

public Style ToolWindowTabItemContainerStyle { get; set; }

Property Value

Style:

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

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.

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.

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.

public void ActivateNextDocument()

public void ActivatePreviousDocument()

public void ActivatePrimaryDocument()

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.

public void CascadeDocuments()

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.

public bool CloseAllDocuments()

Returns

Boolean:

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

Remarks

Only documents that are closable are closed.

public bool ClosePrimaryDocument()

Returns

Boolean:

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

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.

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.

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.

public void DockSiteRegistryConstructor()

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.

protected virtual void InitializeAutoHidePopupWindow(Window window)

Parameter	Type	Description
window	Window	The Window to initialize.

protected virtual void InitializeDockingAdornmentWindow(Window window)

Parameter	Type	Description
window	Window	The Window to initialize.

protected virtual void InitializeFloatingWindow(Window window)

Parameter	Type	Description
window	Window	The Window to initialize.

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.

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.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

An AutomationPeer instance.

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.

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.

protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	KeyboardFocusChangedEventArgs	The KeyboardFocusChangedEventArgs that contains data related to this event.

protected override void OnInitialized(EventArgs e)

Parameter	Type	Description
e	EventArgs

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.

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.

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.

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.

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	A DependencyPropertyChangedEventArgs that contains the event data.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

public void TileDocumentsHorizontally()

public void TileDocumentsVertically()

public string ToHierarchyString()

Returns

String:

The string that was created.

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.

public event EventHandler<FloatingWindowOpeningEventArgs> FloatingWindowOpening

Event Type

EventHandler<FloatingWindowOpeningEventArgs>

public event RoutedEventHandler MdiKindChanged

Event Type

RoutedEventHandler

public event EventHandler<DockingMenuEventArgs> MenuOpening

Event Type

EventHandler<DockingMenuEventArgs>

public event RoutedEventHandler NewWindowRequested

Event Type

RoutedEventHandler

public event EventHandler<DockingWindowEventArgs> PrimaryDocumentChanged

Event Type

EventHandler<DockingWindowEventArgs>

public event EventHandler<DockingWindowEventArgs> WindowActivated

Event Type

EventHandler<DockingWindowEventArgs>

public event EventHandler<DockingWindowEventArgs> WindowAutoHidePopupClosed

Event Type

EventHandler<DockingWindowEventArgs>

public event EventHandler<DockingWindowEventArgs> WindowAutoHidePopupOpened

Event Type

EventHandler<DockingWindowEventArgs>

public event EventHandler<DockingWindowEventArgs> WindowDeactivated

Event Type

EventHandler<DockingWindowEventArgs>

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.

public event EventHandler<DockingWindowEventArgs> WindowRegistered

Event Type

EventHandler<DockingWindowEventArgs>

public event EventHandler<DockingWindowsAutoHidingEventArgs> WindowsAutoHiding

Event Type

EventHandler<DockingWindowsAutoHidingEventArgs>

public event EventHandler<DockingWindowsEventArgs> WindowsClosed

Event Type

EventHandler<DockingWindowsEventArgs>

public event EventHandler<DockingWindowsEventArgs> WindowsClosing

Event Type

EventHandler<DockingWindowsEventArgs>

public event EventHandler<DockingWindowsEventArgs> WindowsDockHostChanged

Event Type

EventHandler<DockingWindowsEventArgs>

public event EventHandler<DockingWindowsEventArgs> WindowsDragged

Event Type

EventHandler<DockingWindowsEventArgs>

public event EventHandler<DockingWindowsEventArgs> WindowsDragging

Event Type

EventHandler<DockingWindowsEventArgs>

public event EventHandler<DockingWindowsDragOverEventArgs> WindowsDragOver

Event Type

EventHandler<DockingWindowsDragOverEventArgs>

public event EventHandler<DockingWindowsEventArgs> WindowsOpened

Event Type

EventHandler<DockingWindowsEventArgs>

public event EventHandler<DockingWindowsEventArgs> WindowsOpening

Event Type

EventHandler<DockingWindowsEventArgs>

public event EventHandler<DockingWindowsEventArgs> WindowsStateChanged

Event Type

EventHandler<DockingWindowsEventArgs>

public event EventHandler<DockingWindowEventArgs> WindowUnregistered

Event Type

EventHandler<DockingWindowEventArgs>

DockHost IDockTarget.DockHost { get; }

Returns

DockHost:

The owner DockHost.

DockSite IDockTarget.DockSite { get; }

Returns

DockSite:

The DockSite that is managing this container.

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.

public static readonly DependencyProperty ActiveWindowProperty

public static readonly DependencyProperty AreDocumentWindowsDestroyedOnCloseProperty

public static readonly DependencyProperty AreNewTabsInsertedBeforeExistingTabsProperty

public static readonly DependencyProperty AutoHidePerContainerProperty

public static readonly DependencyProperty AutoHidePopupCloseAnimationDurationProperty

public static readonly DependencyProperty AutoHidePopupCloseDelayProperty

public static readonly DependencyProperty AutoHidePopupClosesOnLostFocusProperty

public static readonly DependencyProperty AutoHidePopupOpenAnimationDurationProperty

public static readonly DependencyProperty AutoHidePopupOpenDelayProperty

public static readonly DependencyProperty AutoHidePopupOpensOnMouseHoverProperty

public static readonly DependencyProperty AutoHideTabItemTemplateProperty

public static readonly DependencyProperty AutoHideTabItemTemplateSelectorProperty

public static readonly DependencyProperty CanDocumentWindowsCloseProperty

public static readonly DependencyProperty CanDocumentWindowsDragToLinkedDockSitesProperty

public static readonly DependencyProperty CanDocumentWindowsFloatProperty

public static readonly DependencyProperty CanFloatingDockHostsHideOnDockSiteUnloadProperty

public static readonly DependencyProperty CanToolWindowsAttachProperty

public static readonly DependencyProperty CanToolWindowsAutoHideProperty

public static readonly DependencyProperty CanToolWindowsBecomeDocumentsProperty

public static readonly DependencyProperty CanToolWindowsCloseOnMiddleClickProperty

public static readonly DependencyProperty CanToolWindowsCloseProperty

public static readonly DependencyProperty CanToolWindowsDockProperty

public static readonly DependencyProperty CanToolWindowsDragToFloatingDockHostsWithWorkspacesProperty

public static readonly DependencyProperty CanToolWindowsDragToLinkedDockSitesProperty

public static readonly DependencyProperty CanToolWindowsFloatProperty

public static readonly DependencyProperty CanToolWindowTabsDragProperty

public static readonly DependencyProperty CanUpdateItemsSourceOnUnregisterProperty

public static readonly DependencyProperty ChildProperty

public static readonly DependencyProperty ClosePerContainerProperty

public static readonly DependencyProperty DocumentItemContainerStyleProperty

public static readonly DependencyProperty DocumentItemContainerStyleSelectorProperty

public static readonly DependencyProperty DocumentItemsSourceProperty

public static readonly DependencyProperty DocumentItemTemplateProperty

public static readonly DependencyProperty DocumentItemTemplateSelectorProperty

public static readonly DependencyProperty FloatingToolWindowContainersHaveMaximizeButtonsProperty

public static readonly DependencyProperty FloatingToolWindowContainersHaveMinimizeButtonsProperty

public static readonly DependencyProperty FloatingWindowIconProperty

public static readonly RoutedEvent FloatingWindowOpeningEvent

public static readonly DependencyProperty FloatingWindowShowInTaskBarModeProperty

public static readonly DependencyProperty FloatingWindowSnapToScreenThresholdProperty

public static readonly DependencyProperty FloatingWindowTitleProperty

public static readonly DependencyProperty HostedFloatingWindowContainerProperty

public static readonly DependencyProperty InactiveFloatingWindowFadeDelayProperty

public static readonly DependencyProperty InactiveFloatingWindowFadeDurationProperty

public static readonly DependencyProperty InactiveFloatingWindowFadeOpacityProperty

public static readonly DependencyProperty IsDockGuideAnimationEnabledProperty

public static readonly DependencyProperty IsFloatingWindowSnapToScreenEnabledProperty

public static readonly DependencyProperty IsInactiveFloatingWindowFadeEnabledProperty

public static readonly DependencyProperty IsLiveSplittingEnabledProperty

public static readonly DependencyProperty IsTabLayoutAnimationEnabledProperty

public static readonly DependencyProperty MagnetismGapDistanceProperty

public static readonly DependencyProperty MagnetismSnapDistanceProperty

public static readonly RoutedEvent MdiKindChangedEvent

public static readonly DependencyProperty MdiKindProperty

public static readonly RoutedEvent MenuOpeningEvent

public static readonly RoutedEvent NewWindowRequestedEvent

public static readonly RoutedEvent PrimaryDocumentChangedEvent

public static readonly DependencyProperty PrimaryDocumentProperty

public static readonly DependencyProperty SplitterSizeProperty

public static readonly DependencyProperty SwitcherProperty

public static readonly DependencyProperty ToolItemContainerStyleProperty

public static readonly DependencyProperty ToolItemContainerStyleSelectorProperty

public static readonly DependencyProperty ToolItemsSourceProperty

public static readonly DependencyProperty ToolItemTemplateProperty

public static readonly DependencyProperty ToolItemTemplateSelectorProperty

public static readonly DependencyProperty ToolWindowsHaveCloseButtonsProperty

public static readonly DependencyProperty ToolWindowsHaveOptionsButtonsProperty

public static readonly DependencyProperty ToolWindowsHaveTabImagesProperty

public static readonly DependencyProperty ToolWindowsHaveTitleBarIconsProperty

public static readonly DependencyProperty ToolWindowsHaveTitleBarsProperty

public static readonly DependencyProperty ToolWindowsHaveToggleAutoHideButtonsProperty

public static readonly DependencyProperty ToolWindowsSingleTabLayoutBehaviorProperty

public static readonly DependencyProperty ToolWindowsTabOverflowBehaviorProperty

public static readonly DependencyProperty ToolWindowsTabStripPlacementProperty

public static readonly DependencyProperty ToolWindowsTitleBarContextContentAlignmentProperty

public static readonly DependencyProperty ToolWindowTabItemContainerStyleProperty

public static readonly DependencyProperty UseDragFloatPreviewsProperty

public static readonly DependencyProperty UseHostedFloatingWindowsProperty

public static readonly DependencyProperty UseHostedPopupsProperty

public static readonly RoutedEvent WindowActivatedEvent

public static readonly RoutedEvent WindowAutoHidePopupClosedEvent

public static readonly RoutedEvent WindowAutoHidePopupOpenedEvent

public static readonly RoutedEvent WindowDeactivatedEvent

public static readonly RoutedEvent WindowDefaultLocationRequestedEvent

public static readonly RoutedEvent WindowRegisteredEvent

public static readonly RoutedEvent WindowsAutoHidingEvent

public static readonly RoutedEvent WindowsClosedEvent

public static readonly RoutedEvent WindowsClosingEvent

public static readonly RoutedEvent WindowsDockHostChangedEvent

public static readonly RoutedEvent WindowsDraggedEvent

public static readonly RoutedEvent WindowsDraggingEvent

public static readonly RoutedEvent WindowsDragOverEvent

public static readonly RoutedEvent WindowsOpenedEvent

public static readonly RoutedEvent WindowsOpeningEvent

public static readonly RoutedEvent WindowsStateChangedEvent

public static readonly RoutedEvent WindowUnregisteredEvent