Skip to content

DockManager class

Manages a layout of docked, floating, and auto-hidden panes and documents.

Namespace: Eremex.AvaloniaUI.Controls.Docking
Assembly: Eremex.Avalonia.Controls.dll
NuGet Package: Eremex.Avalonia.Controls

Declaration

public class DockManager : TemplatedControl

Public Members

name description
DockManager() Initializes a new instance of the DockManager class.
static GetDockManager(…)
ActiveDockItem { get; } Gets the currently active docking item.
AllowDocumentSwitcher { get; set; } Gets or sets whether users can open the document switcher.
AllowFreeDocumentLayout { get; set; } Gets or sets whether document groups can be arranged in both horizontal and vertical directions within a document host.
AutoHideGroups { get; } Gets the collection of auto-hide groups.
AutoHideMode { get; set; } Gets or sets whether expanded auto-hide panels overlay the docking layout or occupy space within it.
AutoHideOnlyActivePane { get; set; } Gets or sets whether the auto-hide and pin commands affect only the active pane in a tabbed group.
ClosedPanes { get; } Gets the collection of closed panes available for restoration.
CloseOnlyActivePane { get; set; } Gets or sets whether the close command closes only the active pane in a tabbed group.
Commands { get; } Gets the dock manager's commands.
FloatGroups { get; } Gets the collection of floating groups.
ItemAdapter { get; set; } Gets or sets the adapter used to configure a generated docking item for its source item.
ItemContentTemplate { get; set; } Gets or sets the template used to display the content of generated docking panes.
ItemsSource { get; set; } Gets or sets the collection whose items are used to generate docking items.
ItemTemplate { get; set; } Gets or sets the template used to create docking items from the data source.
OwnsFloatingDockPanes { get; set; } Gets or sets whether floating windows containing tool panes are owned by the dock manager's window.
OwnsFloatingDocuments { get; set; } Gets or sets whether floating windows containing documents are owned by the dock manager's window.
Root { get; set; } Gets or sets the root group of the docked layout.
SerializationInfo { get; } Gets the layout information used during serialization or deserialization.
event CustomizeDockGuide Occurs when docking guides are prepared for a dragged item. Use the event to hide guides or guide items.
event DockItemActivated Occurs when the active docking item changes.
event DockItemContextMenuOpening Occurs before a docking item context menu opens. Cancel the event to prevent the menu from opening.
event DockItemEndFloatDragging Occurs when dragging a floating docking item ends.
event DockItemStartFloatDragging Occurs when dragging a floating docking item starts.
event DockOperationCompleted Occurs after a docking operation completes.
event DockOperationStarting Occurs before a docking operation starts. Cancel the event to prevent the operation.
event RegisterDockItem Occurs when a docking item is registered with the dock manager.
AutoHide(…) Moves the panes in the specified item into an auto-hide group and returns whether the operation succeeded.
Close(…) Closes the panes in the specified item and returns whether the operation succeeded.
CollapseAutoHidePanel(…) Collapses the auto-hide panel for the specified pane and returns whether the operation succeeded.
Dock(…) Docks the specified item using its docking history and returns whether the operation succeeded. (2 methods)
ExpandAutoHidePanel(…) Expands the auto-hide panel for the specified pane and returns whether the operation succeeded.
Float(…) Moves the specified item into a floating window and returns whether the operation succeeded.
Remove(…) Removes the specified item and its docking history from the layout and returns whether the operation succeeded.
Restore(…) Restores a closed pane to its previous layout position and returns whether the operation succeeded.
RestoreLayout(…) Restores the docking layout from the specified stream using the default serialization settings. (2 methods)
SaveLayout(…) Saves the docking layout to the specified stream using the default serialization settings. (2 methods)
static GetDockItem(…) Gets the docking item associated with the specified object.
static SetDockItem(…) Sets the docking item associated with the specified object.
static SetDockManager(…) Sets the dock manager associated with the specified object.

See Also

Used in articles