DockSite Class

[TemplatePart(Name = "PART_AdornmentHost", Type = typeof(Panel))]
[TemplatePart(Name = "PART_DockHost", Type = typeof(DockHost))]
public class DockSite : TemplatedControl, IDataContextProvider, ILogical, IThemeVariantHost, IResourceHost, IResourceNode, IStyleHost, ISetLogicalParent, ISetInheritanceParent, IStyleable, INamed, IInputElement, IDataTemplateHost, ISetterValue, IDockTarget

public DockSite()

public ICommand ActivateNextDocumentCommand { get; }

Property Value

ICommand

public KeyGesture? ActivateNextDocumentKeyGesture { get; set; }

Property Value

KeyGesture:

The default value is Ctrl+F6.

See Also

• ActivatePreviousDocumentKeyGesture

public ICommand ActivateNextTabCommand { get; }

Property Value

ICommand

public KeyGesture? ActivateNextTabKeyGesture { get; set; }

Property Value

KeyGesture:

The default value is Ctrl+PageDn on most platforms and Ctrl+Shift+PageDown on browsers.

See Also

• ActivatePreviousTabKeyGesture

public ICommand ActivatePreviousDocumentCommand { get; }

Property Value

ICommand

public KeyGesture? ActivatePreviousDocumentKeyGesture { get; set; }

Property Value

KeyGesture:

The default value is Ctrl+Shift+F6.

See Also

• ActivateNextDocumentKeyGesture

public ICommand ActivatePreviousTabCommand { get; }

Property Value

ICommand

public KeyGesture? ActivatePreviousTabKeyGesture { get; set; }

Property Value

KeyGesture:

The default value is Ctrl+PageUp on most platforms and Ctrl+Shift+PageUp on browsers.

See Also

• ActivateNextTabKeyGesture

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:

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

bool:

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

public ToolWindowContainerCollection AutoHideLeftContainers { get; }

Property Value

ToolWindowContainerCollection

public bool AutoHidePerContainer { get; set; }

Property Value

bool:

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

public double AutoHidePopupCloseDelay { get; set; }

Property Value

double:

The default value is 500.

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:

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

public IDataTemplate? AutoHideTabItemTemplate { get; set; }

Property Value

IDataTemplate

public ToolWindowContainerCollection AutoHideTopContainers { get; }

Property Value

ToolWindowContainerCollection

public bool CanDocumentWindowsClose { get; set; }

Property Value

bool:

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

bool:

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

bool:

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

bool:

true if FloatingDockHosts should hide when the DockSite is detached from the visual tree; otherwise, false. The default value is true.

Remarks

Any FloatingDockHosts that were hidden when the DockSite is detached from the visual tree will be shown again if the DockSite is re-attached to the visual tree.

public bool CanToolWindowTabsDrag { get; set; }

Property Value

bool:

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

Property Value

bool:

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

bool:

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

bool:

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

bool:

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

bool:

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

bool:

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

bool:

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

bool:

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

bool:

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

Property Value

bool:

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

public ICommand CascadeDocumentsCommand { get; }

Property Value

ICommand

[Content]
public Control? Child { get; set; }

Property Value

Control

public ICommand CloseAllDocumentsCommand { get; }

Property Value

ICommand

public bool ClosePerContainer { get; set; }

Property Value

bool:

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

public KeyGesture? ClosePrimaryDocumentKeyGesture { get; set; }

Property Value

KeyGesture:

The default value is Ctrl+F4.

public ControlTheme? DocumentItemContainerTheme { get; set; }

Property Value

ControlTheme

public IDataTemplate? DocumentItemTemplate { get; set; }

Property Value

IDataTemplate:

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 ReadOnlyObservableCollection<DockingWindow> Documents { get; }

Property Value

ReadOnlyObservableCollection<DockingWindow>

public ReadOnlyObservableCollection<DockHost> FloatingDockHosts { get; }

Property Value

ReadOnlyObservableCollection<DockHost>

public FloatingWindowTitleBarDoubleClickMode FloatingToolWindowContainerTitleBarDoubleClickMode { get; set; }

Property Value

FloatingWindowTitleBarDoubleClickMode:

A FloatingWindowTitleBarDoubleClickMode value indicating the behavior. The default value is ToggleMaximized.

public bool FloatingToolWindowContainersHaveMaximizeButtons { get; set; }

Property Value

bool:

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

bool:

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.

[DependsOn("FloatingWindowIconTemplate")]
public object? FloatingWindowIcon { get; set; }

Property Value

object

Remarks

The value generally matches the application icon.

public IDataTemplate? FloatingWindowIconTemplate { get; set; }

Property Value

IDataTemplate

public FloatingWindowOwnerMode FloatingWindowOwnerMode { get; set; }

Property Value

FloatingWindowOwnerMode:

A mode that determines when a floating window should be owned by the main window. The default value is Default.

Remarks

This feature only affects non-hosted floating windows.

public FloatingWindowShowInTaskBarMode FloatingWindowShowInTaskBarMode { get; set; }

Property Value

FloatingWindowShowInTaskBarMode:

A mode that determines when to show floating windows in the taskbar. The default value is 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.

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

• GetFloatingDockHostTitle(DockHost?)

public bool HasDocuments { get; }

Property Value

bool:

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

public Control? HostedFloatingWindowContainer { get; set; }

Property Value

Control:

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

Remarks

The Avalonia.Controls.Control 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:

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

public bool IsFloatingWindowSnapToScreenEnabled { get; set; }

Property Value

bool:

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

bool:

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

bool:

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

public bool IsTabLayoutAnimationEnabled { get; set; }

Property Value

bool:

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>

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:

One of the MdiKind values indicating the kind of MDI currently in use. 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 ControlTheme? ToolItemContainerTheme { get; set; }

Property Value

ControlTheme

public IDataTemplate? ToolItemTemplate { get; set; }

Property Value

IDataTemplate:

The default value is null.

public IEnumerable? ToolItemsSource { get; set; }

Property Value

IEnumerable:

The default value is null.

public ControlTheme? ToolWindowTabItemContainerTheme { get; set; }

Property Value

ControlTheme

public ToolWindowCollection ToolWindows { get; }

Property Value

ToolWindowCollection

public bool ToolWindowsHaveCloseButtons { get; set; }

Property Value

bool:

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

public bool ToolWindowsHaveOptionsButtons { get; set; }

Property Value

bool:

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

public bool ToolWindowsHaveTabIcons { get; set; }

Property Value

bool:

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

Remarks

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

public bool ToolWindowsHaveTitleBarIcons { get; set; }

Property Value

bool:

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

bool:

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

bool:

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 Hide.

public TabOverflowBehavior ToolWindowsTabOverflowBehavior { get; set; }

Property Value

TabOverflowBehavior:

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

public Dock ToolWindowsTabStripPlacement { get; set; }

Property Value

Dock:

The default value is Avalonia.Controls.Dock.Bottom.

public ContextContentAlignment ToolWindowsTitleBarContextContentAlignment { get; set; }

Property Value

ContextContentAlignment:

The default value is Far.

public bool UseDragFloatPreviews { get; set; }

Property Value

bool:

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

bool:

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

public bool UseHostedPopups { get; set; }

Property Value

bool:

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

public void ActivatePreviousDocument()

public void ActivatePreviousTab()

public void ActivatePrimaryDocument()

public static void ApplyContainerTheme(object? item, DockingWindow container, ControlTheme? theme)

Parameter	Type	Description
item	object	The data item.
container	DockingWindow	The container window whose style should be set.
theme	ControlTheme	The desired specific theme.

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 DockingWindow CreateContainerForItemOverride(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 DockHost CreateDockHost()

Returns

DockHost:

The DockHost that was created.

protected virtual StandardMdiHost CreateStandardMdiHost()

Returns

StandardMdiHost:

The StandardMdiHost that was created.

protected virtual TabbedMdiContainer CreateTabbedMdiContainer()

Returns

TabbedMdiContainer:

The TabbedMdiContainer that was created.

protected virtual TabbedMdiHost CreateTabbedMdiHost()

Returns

TabbedMdiHost:

The TabbedMdiHost that was created.

protected virtual ToolWindowContainer CreateToolWindowContainer()

Returns

ToolWindowContainer:

The ToolWindowContainer that was created.

protected virtual Workspace CreateWorkspace()

Returns

Workspace:

The Workspace that was created.

public void DockSiteRegistryConstructor()

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 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 Avalonia.Controls.Window to initialize.

protected virtual void InitializeDockingAdornmentWindow(Window window)

Parameter	Type	Description
window	Window	The Avalonia.Controls.Window to initialize.

protected virtual void InitializeFloatingWindow(Window window)

Parameter	Type	Description
window	Window	The Avalonia.Controls.Window to initialize.

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 bool NeedsContainerOverride(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 needs a container; otherwise, false if the item can itself be used as a container.

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.

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.

protected override void OnApplyTemplate(TemplateAppliedEventArgs e)

Parameter	Type	Description
e	TemplateAppliedEventArgs	The event args.

protected override void OnAttachedToVisualTree(VisualTreeAttachmentEventArgs e)

Parameter	Type	Description
e	VisualTreeAttachmentEventArgs	The event args.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific Avalonia.Automation.Peers.AutomationPeer implementation.

protected override void OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs e)

Parameter	Type	Description
e	VisualTreeAttachmentEventArgs	The event args.

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 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 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 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 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 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 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 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 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 Avalonia.Input.KeyEventArgs that contains 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 EventHandler<RoutedEventArgs>? MdiKindChanged

Event Type

EventHandler<RoutedEventArgs>

public event EventHandler<DockingMenuEventArgs>? MenuOpening

Event Type

EventHandler<DockingMenuEventArgs>

public event EventHandler<RoutedEventArgs>? NewWindowRequested

Event Type

EventHandler<RoutedEventArgs>

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 StyledProperty<KeyGesture?> ActivateNextDocumentKeyGestureProperty

public static readonly StyledProperty<KeyGesture?> ActivateNextTabKeyGestureProperty

public static readonly StyledProperty<KeyGesture?> ActivatePreviousDocumentKeyGestureProperty

public static readonly StyledProperty<KeyGesture?> ActivatePreviousTabKeyGestureProperty

public static readonly StyledProperty<DockingWindow?> ActiveWindowProperty

public static readonly StyledProperty<bool> AreDocumentWindowsDestroyedOnCloseProperty

public static readonly StyledProperty<bool> AreNewTabsInsertedBeforeExistingTabsProperty

public static readonly StyledProperty<bool> AutoHidePerContainerProperty

public static readonly StyledProperty<double> AutoHidePopupCloseAnimationDurationProperty

public static readonly StyledProperty<double> AutoHidePopupCloseDelayProperty

public static readonly StyledProperty<double> AutoHidePopupOpenAnimationDurationProperty

public static readonly StyledProperty<double> AutoHidePopupOpenDelayProperty

public static readonly StyledProperty<bool> AutoHidePopupOpensOnMouseHoverProperty

public static readonly StyledProperty<IDataTemplate?> AutoHideTabItemTemplateProperty

public static readonly StyledProperty<bool> CanDocumentWindowsCloseProperty

public static readonly StyledProperty<bool> CanDocumentWindowsDragToLinkedDockSitesProperty

public static readonly StyledProperty<bool> CanDocumentWindowsFloatProperty

public static readonly StyledProperty<bool> CanFloatingDockHostsHideOnDockSiteUnloadProperty

public static readonly StyledProperty<bool> CanToolWindowTabsDragProperty

public static readonly StyledProperty<bool> CanToolWindowsAttachProperty

public static readonly StyledProperty<bool> CanToolWindowsAutoHideProperty

public static readonly StyledProperty<bool> CanToolWindowsBecomeDocumentsProperty

public static readonly StyledProperty<bool> CanToolWindowsCloseOnMiddleClickProperty

public static readonly StyledProperty<bool> CanToolWindowsCloseProperty

public static readonly StyledProperty<bool> CanToolWindowsDockProperty

public static readonly StyledProperty<bool> CanToolWindowsDragToFloatingDockHostsWithWorkspacesProperty

public static readonly StyledProperty<bool> CanToolWindowsDragToLinkedDockSitesProperty

public static readonly StyledProperty<bool> CanToolWindowsFloatProperty

public static readonly StyledProperty<bool> CanUpdateItemsSourceOnUnregisterProperty

public static readonly StyledProperty<Control?> ChildProperty

public static readonly StyledProperty<bool> ClosePerContainerProperty

public static readonly StyledProperty<KeyGesture?> ClosePrimaryDocumentKeyGestureProperty

public static readonly StyledProperty<ControlTheme?> DocumentItemContainerThemeProperty

public static readonly StyledProperty<IDataTemplate?> DocumentItemTemplateProperty

public static readonly StyledProperty<IEnumerable?> DocumentItemsSourceProperty

public static readonly StyledProperty<FloatingWindowTitleBarDoubleClickMode> FloatingToolWindowContainerTitleBarDoubleClickModeProperty

public static readonly StyledProperty<bool> FloatingToolWindowContainersHaveMaximizeButtonsProperty

public static readonly StyledProperty<bool> FloatingToolWindowContainersHaveMinimizeButtonsProperty

public static readonly StyledProperty<object?> FloatingWindowIconProperty

public static readonly StyledProperty<IDataTemplate?> FloatingWindowIconTemplateProperty

public static readonly RoutedEvent<FloatingWindowOpeningEventArgs> FloatingWindowOpeningEvent

public static readonly StyledProperty<FloatingWindowOwnerMode> FloatingWindowOwnerModeProperty

public static readonly StyledProperty<FloatingWindowShowInTaskBarMode> FloatingWindowShowInTaskBarModeProperty

public static readonly StyledProperty<double> FloatingWindowSnapToScreenThresholdProperty

public static readonly StyledProperty<string?> FloatingWindowTitleDelimiterProperty

public static readonly StyledProperty<string?> FloatingWindowTitleProperty

public static readonly StyledProperty<Control?> HostedFloatingWindowContainerProperty

public static readonly StyledProperty<double> InactiveFloatingWindowFadeDelayProperty

public static readonly StyledProperty<double> InactiveFloatingWindowFadeDurationProperty

public static readonly StyledProperty<double> InactiveFloatingWindowFadeOpacityProperty

public static readonly StyledProperty<bool> IsDockGuideAnimationEnabledProperty

public static readonly StyledProperty<bool> IsFloatingWindowSnapToScreenEnabledProperty

public static readonly StyledProperty<bool> IsInactiveFloatingWindowFadeEnabledProperty

public static readonly StyledProperty<bool> IsLiveSplittingEnabledProperty

public static readonly StyledProperty<bool> IsTabLayoutAnimationEnabledProperty

public static readonly StyledProperty<double> MagnetismGapDistanceProperty

public static readonly StyledProperty<double> MagnetismSnapDistanceProperty

public static readonly RoutedEvent<RoutedEventArgs> MdiKindChangedEvent

public static readonly StyledProperty<MdiKind> MdiKindProperty

public static readonly RoutedEvent<DockingMenuEventArgs> MenuOpeningEvent

public static readonly RoutedEvent<RoutedEventArgs> NewWindowRequestedEvent

public static readonly RoutedEvent<DockingWindowEventArgs> PrimaryDocumentChangedEvent

public static readonly StyledProperty<DockingWindow?> PrimaryDocumentProperty

public static readonly StyledProperty<double> SplitterSizeProperty

public static readonly StyledProperty<SwitcherBase?> SwitcherProperty

public static readonly StyledProperty<ControlTheme?> ToolItemContainerThemeProperty

public static readonly StyledProperty<IDataTemplate?> ToolItemTemplateProperty

public static readonly StyledProperty<IEnumerable?> ToolItemsSourceProperty

public static readonly StyledProperty<ControlTheme?> ToolWindowTabItemContainerThemeProperty

public static readonly StyledProperty<bool> ToolWindowsHaveCloseButtonsProperty

public static readonly StyledProperty<bool> ToolWindowsHaveOptionsButtonsProperty

public static readonly StyledProperty<bool> ToolWindowsHaveTabIconsProperty

public static readonly StyledProperty<bool> ToolWindowsHaveTitleBarIconsProperty

public static readonly StyledProperty<bool> ToolWindowsHaveTitleBarsProperty

public static readonly StyledProperty<bool> ToolWindowsHaveToggleAutoHideButtonsProperty

public static readonly StyledProperty<SingleTabLayoutBehavior> ToolWindowsSingleTabLayoutBehaviorProperty

public static readonly StyledProperty<TabOverflowBehavior> ToolWindowsTabOverflowBehaviorProperty

public static readonly StyledProperty<Dock> ToolWindowsTabStripPlacementProperty

public static readonly StyledProperty<ContextContentAlignment> ToolWindowsTitleBarContextContentAlignmentProperty

public static readonly StyledProperty<bool> UseDragFloatPreviewsProperty

public static readonly StyledProperty<bool> UseHostedFloatingWindowsProperty

public static readonly StyledProperty<bool> UseHostedPopupsProperty

public static readonly RoutedEvent<DockingWindowEventArgs> WindowActivatedEvent

public static readonly RoutedEvent<DockingWindowEventArgs> WindowAutoHidePopupClosedEvent

public static readonly RoutedEvent<DockingWindowEventArgs> WindowAutoHidePopupOpenedEvent

public static readonly RoutedEvent<DockingWindowEventArgs> WindowDeactivatedEvent

public static readonly RoutedEvent<DockingWindowDefaultLocationEventArgs> WindowDefaultLocationRequestedEvent

public static readonly RoutedEvent<DockingWindowEventArgs> WindowRegisteredEvent

public static readonly RoutedEvent<DockingWindowEventArgs> WindowUnregisteredEvent

public static readonly RoutedEvent<DockingWindowsAutoHidingEventArgs> WindowsAutoHidingEvent

public static readonly RoutedEvent<DockingWindowsEventArgs> WindowsClosedEvent

public static readonly RoutedEvent<DockingWindowsEventArgs> WindowsClosingEvent

public static readonly RoutedEvent<DockingWindowsEventArgs> WindowsDockHostChangedEvent

public static readonly RoutedEvent<DockingWindowsDragOverEventArgs> WindowsDragOverEvent

public static readonly RoutedEvent<DockingWindowsEventArgs> WindowsDraggedEvent

public static readonly RoutedEvent<DockingWindowsEventArgs> WindowsDraggingEvent

public static readonly RoutedEvent<DockingWindowsEventArgs> WindowsOpenedEvent

public static readonly RoutedEvent<DockingWindowsEventArgs> WindowsOpeningEvent

public static readonly RoutedEvent<DockingWindowsEventArgs> WindowsStateChangedEvent