DockSite Class

[TemplatePart(Name = "PART_AdornmentHost", Type = typeof(Panel))]
[TemplatePart(Name = "PART_DockHost", Type = typeof(DockHost))]
public class DockSite : Control, IDockTarget

public DockSite()

public ICommand ActivateNextDocumentCommand { get; }

Property Value

ICommand

public ICommand ActivateNextTabCommand { get; }

Property Value

ICommand

public ICommand ActivatePreviousDocumentCommand { get; }

Property Value

ICommand

public ICommand ActivatePreviousTabCommand { get; }

Property Value

ICommand

public ICommand ActivatePrimaryDocumentCommand { get; }

Property Value

ICommand

public DockingWindow? ActiveWindow { get; }

Property Value

DockingWindow

Remarks

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

public bool AreDocumentWindowsDestroyedOnClose { get; set; }

Property Value

bool:

The default value is true.

public bool AreNewTabsInsertedBeforeExistingTabs { get; set; }

Property Value

bool:

The default value is true.

public ToolWindowContainerCollection AutoHideBottomContainers { get; }

Property Value

ToolWindowContainerCollection

public ToolWindowContainerCollection AutoHideLeftContainers { get; }

Property Value

ToolWindowContainerCollection

public bool AutoHidePerContainer { get; set; }

Property Value

bool:

The default value is true.

public double AutoHidePopupCloseAnimationDuration { get; set; }

Property Value

double:

The default value is 150.

public double AutoHidePopupCloseDelay { get; set; }

Property Value

double:

The default value is 500.

public bool AutoHidePopupClosesOnLostFocus { get; set; }

Property Value

bool:

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 default value is 150.

public double AutoHidePopupOpenDelay { get; set; }

Property Value

double:

The default value is 200.

public bool AutoHidePopupOpensOnMouseHover { get; set; }

Property Value

bool:

The default value is false for most themes, but may be true for some themes.

public ToolWindowContainerCollection AutoHideRightContainers { get; }

Property Value

ToolWindowContainerCollection

public DataTemplate? AutoHideTabItemTemplate { get; set; }

Property Value

DataTemplate

public DataTemplateSelector? AutoHideTabItemTemplateSelector { get; set; }

Property Value

DataTemplateSelector

public ToolWindowContainerCollection AutoHideTopContainers { get; }

Property Value

ToolWindowContainerCollection

public bool CanDocumentWindowsClose { get; set; }

Property Value

bool:

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

bool:

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

bool:

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

bool:

The default value is true.

public bool CanToolWindowTabsDrag { get; set; }

Property Value

bool:

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 CanToolWindowsAttach { get; set; }

Property Value

bool:

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

bool:

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

bool:

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

bool:

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

bool:

The default value is true.

public bool CanToolWindowsDock { get; set; }

Property Value

bool:

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

bool:

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

bool:

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

bool:

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 CanUpdateItemsSourceOnUnregister { get; set; }

Property Value

bool:

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 or a fixed size. Otherwise, the WindowUnregistered event should be monitored and the items source updated manually.

public ICommand CascadeDocumentsCommand { get; }

Property Value

ICommand

public FrameworkElement? Child { get; set; }

Property Value

FrameworkElement

public ICommand CloseAllDocumentsCommand { get; }

Property Value

ICommand

public bool ClosePerContainer { get; set; }

Property Value

bool:

The default value is false.

public ICommand ClosePrimaryDocumentCommand { get; }

Property Value

ICommand

public Style? DocumentItemContainerStyle { get; set; }

Property Value

Style:

The default value is null.

public StyleSelector? DocumentItemContainerStyleSelector { get; set; }

Property Value

StyleSelector:

The default value is null.

public DataTemplate? DocumentItemTemplate { get; set; }

Property Value

DataTemplate:

The default value is null.

public DataTemplateSelector? DocumentItemTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The default value is null.

public IEnumerable? DocumentItemsSource { get; set; }

Property Value

IEnumerable:

The default value is null.

public DocumentWindowCollection DocumentWindows { get; }

Property Value

DocumentWindowCollection

public ReadOnlyDockingWindowCollection Documents { get; }

Property Value

ReadOnlyDockingWindowCollection

public ReadOnlyObservableCollection<DockHost> FloatingDockHosts { get; }

Property Value

ReadOnlyObservableCollection<DockHost>

public FloatingWindowTitleBarDoubleClickMode FloatingToolWindowContainerTitleBarDoubleClickMode { get; set; }

Property Value

FloatingWindowTitleBarDoubleClickMode:

The default value is ToggleMaximized.

public bool FloatingToolWindowContainersHaveMaximizeButtons { get; set; }

Property Value

bool:

The default value is true.

Remarks

This property only affects non-hosted floating windows.

public bool FloatingToolWindowContainersHaveMinimizeButtons { get; set; }

Property Value

bool:

The default value is false.

Remarks

This property only affects non-hosted floating windows.

public ImageSource? FloatingWindowIcon { get; set; }

Property Value

ImageSource

Remarks

The value is generally the same as your application icon.

public FloatingWindowOwnerMode FloatingWindowOwnerMode { get; set; }

Property Value

FloatingWindowOwnerMode:

The default value is Default.

Remarks

This feature only affects non-hosted floating windows.

public FloatingWindowShowInTaskBarMode FloatingWindowShowInTaskBarMode { get; set; }

Property Value

FloatingWindowShowInTaskBarMode:

The default value is Default.

Remarks

This feature only affects non-hosted floating windows.

public double FloatingWindowSnapToScreenThreshold { get; set; }

Property Value

double:

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

Remarks

The value is generally the same as the application name.

See Also

• GetFloatingDockHostTitle(DockHost)

public string? FloatingWindowTitleDelimiter { get; set; }

Property Value

string:

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

• GetFloatingDockHostTitle(DockHost)

public bool HasDocuments { get; }

Property Value

bool

public FrameworkElement? HostedFloatingWindowContainer { get; set; }

Property Value

FrameworkElement

Remarks

The FrameworkElement must be the DockSite or one of it's visual ancestors.

public double InactiveFloatingWindowFadeDelay { get; set; }

Property Value

double:

The default value is 20000 (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 default value is 20000 (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 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

bool:

The default value is true.

public bool IsFloatingWindowSnapToScreenEnabled { get; set; }

Property Value

bool:

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

bool:

The default value is true.

Remarks

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

public bool IsLiveSplittingEnabled { get; set; }

Property Value

bool:

The default value is true.

public bool IsTabLayoutAnimationEnabled { get; set; }

Property Value

bool:

The default value is true.

public IEnumerable<DockSite> LinkedDockSites { get; }

Property Value

IEnumerable<DockSite>

public double MagnetismGapDistance { get; set; }

Property Value

double:

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 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:

The default value is None.

public DockHost? PrimaryDockHost { get; }

Property Value

DockHost

public DockingWindow? PrimaryDocument { get; }

Property Value

DockingWindow

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

public double SplitterSize { get; set; }

Property Value

double:

The default value is 5.

public SwitcherBase? Switcher { get; set; }

Property Value

SwitcherBase

public ICommand TileDocumentsHorizontallyCommand { get; }

Property Value

ICommand

public ICommand TileDocumentsVerticallyCommand { get; }

Property Value

ICommand

public Style? ToolItemContainerStyle { get; set; }

Property Value

Style:

The default value is null.

public StyleSelector? ToolItemContainerStyleSelector { get; set; }

Property Value

StyleSelector:

The default value is null.

public DataTemplate? ToolItemTemplate { get; set; }

Property Value

DataTemplate:

The default value is null.

public DataTemplateSelector? ToolItemTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The default value is null.

public IEnumerable? ToolItemsSource { get; set; }

Property Value

IEnumerable:

The default value is null.

public Style? ToolWindowTabItemContainerStyle { get; set; }

Property Value

Style

public ToolWindowCollection ToolWindows { get; }

Property Value

ToolWindowCollection

public bool ToolWindowsHaveCloseButtons { get; set; }

Property Value

bool:

The default value is true.

public bool ToolWindowsHaveOptionsButtons { get; set; }

Property Value

bool:

The default value is true.

public bool ToolWindowsHaveTabImages { get; set; }

Property Value

bool:

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

bool:

The default value is false.

public bool ToolWindowsHaveTitleBars { get; set; }

Property Value

bool:

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

bool:

The default value is true.

public SingleTabLayoutBehavior ToolWindowsSingleTabLayoutBehavior { get; set; }

Property Value

SingleTabLayoutBehavior:

The default value is Hide.

public TabOverflowBehavior ToolWindowsTabOverflowBehavior { get; set; }

Property Value

TabOverflowBehavior:

The default value is Shrink.

public Side ToolWindowsTabStripPlacement { get; set; }

Property Value

Side:

The default value is Bottom.

public ContextContentAlignment ToolWindowsTitleBarContextContentAlignment { get; set; }

Property Value

ContextContentAlignment:

The default value is Far.

public bool UseDragFloatPreviews { get; set; }

Property Value

bool:

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

bool:

The default value is false.

public bool UseHostedPopups { get; set; }

Property Value

bool:

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

public void ActivatePreviousDocument()

public void ActivatePreviousTab()

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

bool:

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

Remarks

Only documents that are closable are closed.

public bool ClosePrimaryDocument()

Returns

bool:

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.

protected virtual DockHost CreateDockHost()

Returns

DockHost

protected virtual StandardMdiHost CreateStandardMdiHost()

Returns

StandardMdiHost

protected virtual TabbedMdiContainer CreateTabbedMdiContainer()

Returns

TabbedMdiContainer

protected virtual TabbedMdiHost CreateTabbedMdiHost()

Returns

TabbedMdiHost

protected virtual ToolWindowContainer CreateToolWindowContainer()

Returns

ToolWindowContainer

protected virtual Workspace CreateWorkspace()

Returns

Workspace

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 string? GetFloatingDockHostTitle(DockHost dockHost)

Parameter	Type	Description
dockHost	DockHost	The DockHost to examine.

Returns

string

Remarks

The default implementation of this method will use the title of the selected ToolWindow if there is a single ToolWindowContainer in the DockHost. Otherwise, it 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

• FloatingWindowTitle
• FloatingWindowTitleDelimiter

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

bool:

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.

See Also

• UnlinkDockSite(DockSite)

protected virtual void NotifyWindowDragMove(Point location)

Parameter	Type	Description
location	Point	The new pointer location. When UseHostedFloatingWindows is true, the location is expressed relative to the containing control; otherwise, the value is the location in screen coordinates (Avalonia) or device independent screen position (WPF).

Remarks

This method's default implementation calls into the internal drag processor that updates dock guides on pointer movement. Ensure that any overrides of this method call the base implementation.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific AutomationPeer implementation.

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 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 the event data.

protected override void OnInitialized(EventArgs e)

Parameter	Type	Description
e	EventArgs	The RoutedEventArgs that contains the event data.

protected virtual void OnMdiKindChanged(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	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 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 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 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	The event data that describes the property that changed, as well as old and new values.

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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 event data.

public void TileDocumentsHorizontally()

public void TileDocumentsVertically()

public string ToHierarchyString()

Returns

string

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.

See Also

• LinkDockSite(DockSite)

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<DockingWindowEventArgs> WindowUnregistered

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<DockingWindowsDragOverEventArgs> WindowsDragOver

Event Type

EventHandler<DockingWindowsDragOverEventArgs>

public event EventHandler<DockingWindowsEventArgs> WindowsDragged

Event Type

EventHandler<DockingWindowsEventArgs>

public event EventHandler<DockingWindowsEventArgs> WindowsDragging

Event Type

EventHandler<DockingWindowsEventArgs>

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 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 CanToolWindowTabsDragProperty

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 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 DocumentItemTemplateProperty

public static readonly DependencyProperty DocumentItemTemplateSelectorProperty

public static readonly DependencyProperty DocumentItemsSourceProperty

public static readonly DependencyProperty FloatingToolWindowContainerTitleBarDoubleClickModeProperty

public static readonly DependencyProperty FloatingToolWindowContainersHaveMaximizeButtonsProperty

public static readonly DependencyProperty FloatingToolWindowContainersHaveMinimizeButtonsProperty

public static readonly DependencyProperty FloatingWindowIconProperty

public static readonly RoutedEvent FloatingWindowOpeningEvent

public static readonly DependencyProperty FloatingWindowOwnerModeProperty

public static readonly DependencyProperty FloatingWindowShowInTaskBarModeProperty

public static readonly DependencyProperty FloatingWindowSnapToScreenThresholdProperty

public static readonly DependencyProperty FloatingWindowTitleDelimiterProperty

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 ToolItemTemplateProperty

public static readonly DependencyProperty ToolItemTemplateSelectorProperty

public static readonly DependencyProperty ToolItemsSourceProperty

public static readonly DependencyProperty ToolWindowTabItemContainerStyleProperty

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 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 WindowUnregisteredEvent

public static readonly RoutedEvent WindowsAutoHidingEvent

public static readonly RoutedEvent WindowsClosedEvent

public static readonly RoutedEvent WindowsClosingEvent

public static readonly RoutedEvent WindowsDockHostChangedEvent

public static readonly RoutedEvent WindowsDragOverEvent

public static readonly RoutedEvent WindowsDraggedEvent

public static readonly RoutedEvent WindowsDraggingEvent

public static readonly RoutedEvent WindowsOpenedEvent

public static readonly RoutedEvent WindowsOpeningEvent

public static readonly RoutedEvent WindowsStateChangedEvent