DockManager Class

public DockManager()

Remarks

The default constructor initializes all fields to their default values.

[Browsable(false)]
public TabbedMdiWindowCollection ActiveDocuments { get; }

Property Value

TabbedMdiWindowCollection:

A DocumentWindowCollection containing the collection of active TabbedMdiWindow controls in the MDI area.

public bool AutoCreateToolWindowsForLayoutLoad { get; set; }

Property Value

bool:

true if tool windows should be automatically created; otherwise, false.

public bool AutoHideButtonAffectsSelectedTabOnly { get; set; }

Property Value

bool:

true if the pressing of the auto-hide button affects the selected tab only; otherwise, false.

public int AutoHideCloseDelay { get; set; }

Property Value

int:

The delay (in milliseconds) to leave a visible auto-hide window open when the mouse moves away from it. The default value is 1000 milliseconds, or 1 second.

[Browsable(false)]
public static Command AutoHideCommand { get; }

Property Value

Command:

The Command that is used for auto-hide.

public int AutoHideHideSteps { get; set; }

Property Value

int:

The number of steps to use for animation when hiding auto-hide tool windows. The default value is 10.

Remarks

Set this value to 1 for instantaneous hiding.

public bool AutoHideShowOnMouseHover { get; set; }

Property Value

bool:

true if auto-hidden tool windows should be displayed when the mouse hovers over their tabs; otherwise, false.

Remarks

When this property is false, the user must click on a tab to display its related tool window. Clicking on the tab again while the tool window is displayed will close the flyout.

public int AutoHideShowSteps { get; set; }

Property Value

int:

The number of steps to use for animation when showing auto-hide tool windows. The default value is 10.

Remarks

Set this value to 1 for instantaneous showing.

[Browsable(false)]
public AutoHideTabStripPanel AutoHideTabStripPanelBottom { get; }

Property Value

AutoHideTabStripPanel:

The AutoHideTabStripPanel that is currently in use for the bottom side of the host container, if any.

[Browsable(false)]
public AutoHideTabStripPanel AutoHideTabStripPanelLeft { get; }

Property Value

AutoHideTabStripPanel:

The AutoHideTabStripPanel that is currently in use for the left side of the host container, if any.

[Browsable(false)]
public AutoHideTabStripPanel AutoHideTabStripPanelRight { get; }

Property Value

AutoHideTabStripPanel:

The AutoHideTabStripPanel that is currently in use for the right side of the host container, if any.

[Browsable(false)]
public AutoHideTabStripPanel AutoHideTabStripPanelTop { get; }

Property Value

AutoHideTabStripPanel:

The AutoHideTabStripPanel that is currently in use for the top side of the host container, if any.

public bool AutoSelectTabOnDragOver { get; set; }

Property Value

bool:

true if a TabbedMdiWindow should be automatically selected when a drag operation is moved over its tab; otherwise, false.

public bool CloseButtonAffectsSelectedTabOnly { get; set; }

Property Value

bool:

true if the pressing of the close button affects the selected tab only; otherwise, false.

[Browsable(false)]
public static Command CloseCommand { get; }

Property Value

Command:

The Command that is used for a close.

public FormWindowState DefaultMdiWindowState { get; set; }

Property Value

FormWindowState:

The default FormWindowState to assign to MDI windows when they are created.

public bool DisposeDocumentWindowsAfterClose { get; set; }

Property Value

bool:

true if DocumentWindow objects should be automatically disposed after they are closed; otherwise, false.

public DockGuideStyle DockGuideStyle { get; set; }

Property Value

DockGuideStyle:

A DockGuideStyle indicating the style of dock guides to use.

public DockHintStyle DockHintStyle { get; set; }

Property Value

DockHintStyle:

A DockHintStyle indicating the style of docking hints to use.

public DockObjectType DockObjectType { get; }

Property Value

DockObjectType:

A DockObjectType specifying the type of dock object.

public IDockRenderer DockRenderer { get; set; }

Property Value

IDockRenderer:

The IDockRenderer used to render the dock controls.

[Browsable(false)]
public IDockRenderer DockRendererResolved { get; }

Property Value

IDockRenderer:

The IDockRenderer used to render the dock controls.

Remarks

This property will return a global renderer if there is no control instance renderer override. The registered renderer type with the UIRendererManager for this property is IDockRenderer.

[Browsable(false)]
public XmlDocument DocumentLayoutData { get; set; }

Property Value

XmlDocument:

An XmlDocument containing the layout data of the current tabbed MDI document layout.

Remarks

This property may throw an exception while loading if the layout data is invalid.

public DocumentMdiStyle DocumentMdiStyle { get; set; }

Property Value

DocumentMdiStyle:

The DocumentMdiStyle indicating the type of MDI to use for documents.

[Browsable(false)]
public DocumentWindowCollection DocumentWindows { get; }

Property Value

DocumentWindowCollection:

A DocumentWindowCollection containing the collection of DocumentWindow controls being managed by this DockManager.

public bool DocumentWindowsCanClose { get; set; }

Property Value

bool:

true if document windows can be closed; otherwise, false.

Remarks

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

public bool DocumentWindowsCanFloat { get; set; }

Property Value

bool:

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

Remarks

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

public TabbedMdiWindow FocusedTabbedMdiWindow { get; }

Property Value

TabbedMdiWindow:

The TabbedMdiWindow that currently contains the focus.
A null reference is returned if no window currently has the focus.

[Browsable(false)]
public ToolWindow FocusedToolWindow { get; }

Property Value

ToolWindow:

The ToolWindow that currently contains the focus.
A null reference is returned if no tool window currently has the focus.

public bool HideAutoHideToolWindowsAfterStateChange { get; set; }

Property Value

bool:

true if the auto-hide windows should be hidden; otherwise, false.

public bool HideUnfocusedAutoHideToolWindowsOnMouseLeave { get; set; }

Property Value

bool:

true if the unfocused auto-hide windows should be hidden; otherwise, false.

public ContainerControl HostContainerControl { get; set; }

Property Value

ContainerControl:

The ContainerControl that should be used as the topmost parent for docking.

public bool IgnoreAutoHideMouseClicks { get; set; }

Property Value

bool:

true if mouse clicks outside a displayed auto-hide window should close it; otherwise, false.

public ImageList ImageList { get; set; }

Property Value

ImageList:

An ImageList. The default value is a null reference.

public bool KeyboardNavigationEnabled { get; set; }

Property Value

bool:

true if keyboard navigation is enabled when the NextWindowNavigationEnabled is false; otherwise, false.

Remarks

If NextWindowNavigationEnabled is false and keyboard navigation is enabled, the Ctrl+Tab and Ctrl+Shift+Tab keys will switch documents.

public int MagnetismGapDistance { get; set; }

Property Value

int:

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

Property Value

int:

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

Property Value

bool:

true if multiple tabbed MDI groups are enabled; otherwise, false.

Remarks

If set to false, run-time end user features for creating new tabbed MDI groups will not display.

[Browsable(false)]
public bool NextWindowNavigationActive { get; }

Property Value

bool:

true if next window navigation is currently active; otherwise, false.

public bool NextWindowNavigationEnabled { get; set; }

Property Value

bool:

true if next window navigation is enabled; otherwise, false.

Remarks

If next window navigation is enabled, the Ctrl+Tab and Ctrl+Shift+Tab keys will activate the form for document window navigation, and the Alt+F7 and Alt+Shift+F7 keys will activate the form for tool window navigation.

public NextWindowNavigationType NextWindowNavigationType { get; set; }

Property Value

NextWindowNavigationType:

A NextWindowNavigationType indicating the type of functionality to provide.

[Browsable(false)]
public static Command OptionsCommand { get; }

Property Value

Command:

The Command that is used for more options.

[Browsable(false)]
public TabbedMdiWindow SelectedDocument { get; }

Property Value

TabbedMdiWindow:

The TabbedMdiWindow that is currently selected.

public bool StandardMdiAutoWindowLayoutEnabled { get; set; }

Property Value

bool:

true if new windows that display in standard MDI will be automatically positioned; otherwise, false.

public TabbedMdiContainerButtonStyle TabbedMdiContainerButtonStyle { get; set; }

Property Value

TabbedMdiContainerButtonStyle:

A TabbedMdiContainerButtonStyle that indicates the button style.

public ITabStripRenderer TabbedMdiContainerTabStripRenderer { get; set; }

Property Value

ITabStripRenderer:

The control-specific ITabStripRenderer to use for drawing the TabStrip controls in tabbed MDI containers.

[Browsable(false)]
public ITabStripRenderer TabbedMdiContainerTabStripRendererResolved { get; }

Property Value

ITabStripRenderer:

The ITabStripRenderer used for drawing the TabStrip controls in tabbed MDI containers.

Remarks

This property will return a global renderer if there is no control instance renderer override. The registered renderer type with the UIRendererManager for this property is IDocumentWindowTabStripRenderer.

public bool TabbedMdiDragDropEnabled { get; set; }

Property Value

bool:

true if tabbed MDI tabs support drag/drop; otherwise, false.

public int TabbedMdiMaximumTabExtent { get; set; }

Property Value

int:

The maximum extent of an MDI tab.

public bool TabbedMdiRightClickSelectsTab { get; set; }

Property Value

bool:

true if a right-click on a tab selects the related page; otherwise, false.

[Browsable(false)]
public TabbedMdiRootContainer TabbedMdiRootContainer { get; }

Property Value

TabbedMdiRootContainer:

The TabbedMdiRootContainer that is currently in use.

Remarks

This property only returns a value if the DocumentMdiStyle is Tabbed.

public bool TabbedMdiSingleTabVisible { get; set; }

Property Value

bool:

true if the tab should be visible; otherwise, false.

public bool TabbedMdiTabImagesVisible { get; set; }

Property Value

bool:

true if images should be displayed in tabbed MDI window tabs; otherwise, false.

public bool TabbedMdiTabsAlignNear { get; set; }

Property Value

bool:

true if the tabs in tabbed MDIshould align on the near side of the tab container; otherwise, false.

public bool TabbedMdiWindowsInsertAtEnd { get; set; }

Property Value

bool:

true if new windows placed in the tabbed MDI area insert at the end of the current tab group; otherwise, false.

public ITabStripRenderer ToolWindowContainerTabStripRenderer { get; set; }

Property Value

ITabStripRenderer:

The control-specific ITabStripRenderer to use for drawing the TabStrip controls in tool window containers.

[Browsable(false)]
public ITabStripRenderer ToolWindowContainerTabStripRendererResolved { get; }

Property Value

ITabStripRenderer:

The ITabStripRenderer used for drawing the TabStrip controls in tool window containers.

Remarks

This property will return a global renderer if there is no control instance renderer override. The registered renderer type with the UIRendererManager for this property is IToolWindowTabStripRenderer.

[Browsable(false)]
public XmlDocument ToolWindowLayoutData { get; set; }

Property Value

XmlDocument:

An XmlDocument containing the layout data of the current tool window layout.

Remarks

This property may throw an exception while loading if the layout data is invalid.

public bool ToolWindowScreenBoundsCheckEnabled { get; set; }

Property Value

bool:

true if tool windows should be forced back onto a visible Screen when undocked; otherwise, false.

[Browsable(false)]
public ToolWindowCollection ToolWindows { get; }

Property Value

ToolWindowCollection:

A ToolWindowCollection containing the collection of ToolWindow controls being managed by this DockManager.

public bool ToolWindowsCanAttach { get; set; }

Property Value

bool:

true if tool windows may be attached to another tool window; otherwise, false.

Remarks

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

public bool ToolWindowsCanAutoHide { get; set; }

Property Value

bool:

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

Remarks

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

public bool ToolWindowsCanBecomeDocuments { get; set; }

Property Value

bool:

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

Remarks

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

public bool ToolWindowsCanClose { get; set; }

Property Value

bool:

true if tool windows can be closed; otherwise, false.

Remarks

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

public bool ToolWindowsCanDockHostBottom { get; set; }

Property Value

bool:

true if tool windows may be docked to the bottom of the host container control; otherwise, false.

Remarks

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

public bool ToolWindowsCanDockHostLeft { get; set; }

Property Value

bool:

true if tool windows may be docked to the left of the host container control; otherwise, false.

Remarks

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

public bool ToolWindowsCanDockHostRight { get; set; }

Property Value

bool:

true if tool windows may be docked to the right of the host container control; otherwise, false.

Remarks

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

public bool ToolWindowsCanDockHostTop { get; set; }

Property Value

bool:

true if tool windows may be docked to the top of the host container control; otherwise, false.

Remarks

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

public bool ToolWindowsCanDrag { get; set; }

Property Value

bool:

true if tool windows may be dragged to another location; otherwise, false.

Remarks

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

public bool ToolWindowsCanFloat { get; set; }

Property Value

bool:

true if tool windows may be contained in a floating window; otherwise, false.

Remarks

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

public bool ToolWindowsCanResize { get; set; }

Property Value

bool:

true if tool windows may be resized; otherwise, false.

Remarks

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

public bool ToolWindowsHaveOptions { get; set; }

Property Value

bool:

true if tool windows have more options available than the standard options; otherwise, false.

Remarks

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

public bool ToolWindowsHaveTitleBars { get; set; }

Property Value

bool:

true if tool windows display a title bar when docked; otherwise, false.

Remarks

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

public bool UnknownToolWindowStatePreservationEnabled { get; set; }

Property Value

bool:

true if the DockManager will persist layout information for unknown tool windows when loading a layout; otherwise, false.

public virtual void ExecuteTabbedMdiWindowContextMenuItem(TabbedMdiWindow tabbedMdiWindow, TabbedMdiWindowContextMenuItemType menuItemType)

Exceptions

public XmlDocument GetToolWindowLayoutData(bool saveTextProperties)

Returns

XmlDocument:

An XmlDocument containing the layout data of the current tool window layout.

public bool HideVisibleAutoHideToolWindow(bool instantaneous)

Returns

bool

Remarks

true if a tool window was hidden; otherwise, false.

public virtual bool IsMenuItemEnabled(DockManagerMenuItemType menuItemType)

Returns

bool:

true if the menu item type should be enabled; otherwise, false.

public virtual bool IsMenuItemVisible(DockManagerMenuItemType menuItemType)

Returns

bool:

true if the menu item type should be visible; otherwise, false.

public void LoadDocumentLayoutFromFile(string path)

Remarks

This method may throw an exception if the file is not found or if the layout data is invalid.

public void LoadToolWindowLayoutFromFile(string path)

Remarks

This method may throw an exception if the file is not found or if the layout data is invalid.

public void SaveDocumentLayoutToFile(string path)

Remarks

The output layout data is stored in XML format.

public void SaveToolWindowLayoutToFile(string path)

Remarks

The output layout data is stored in XML format.

public void SaveToolWindowLayoutToFile(string path, bool saveTextProperties)

Remarks

The output layout data is stored in XML format.

public bool ShowNextWindowNavForm(Keys keys, bool toolWindowMode, bool selectNext)

Returns

bool:

true if the key should be handled; otherwise, false.

public static TabbedMdiWindow TabbedMdiWindowFromControl(Control control)

Returns

TabbedMdiWindow:

The TabbedMdiWindow, if any, that contains the specified Control.

public bool UnknownToolWindowStatePreservationInfoExistsFor(string key)

Returns

bool:

true if layout information is available; otherwise, false.

public event TabbedMdiWindowContextMenuEventHandler ActiveFilesContextMenu

Event Type

TabbedMdiWindowContextMenuEventHandler

Remarks

Set the Cancel member of the event arguments to true if the default context menu should not be displayed. This is useful when displaying custom menus. The TabbedMdiWindow member of the event arguments indicates the currently selected TabbedMdiWindow in the tabbed MDI container of which the button was pressed.

public event TabbedMdiWindowEventHandler AutoHideToolWindowDisplaying

Event Type

TabbedMdiWindowEventHandler

public event TabbedMdiWindowEventHandler AutoHideToolWindowHiding

Event Type

TabbedMdiWindowEventHandler

public event DockLoadCustomToolWindowLayoutDataEventHandler LoadCustomToolWindowLayoutData

Event Type

DockLoadCustomToolWindowLayoutDataEventHandler

Remarks

Use the Reader property to enumerate through the custom XML data found in the layout stream.

public event EventHandler NextWindowNavigationActiveChanged

Event Type

EventHandler

Remarks

Examine the NextWindowNavigationActive property to determine if the form is currently visible.

public event NextWindowNavigationEventHandler NextWindowNavigationSelectionChanged

Event Type

NextWindowNavigationEventHandler

Remarks

Use the event argument properties to customize the text to display for the current selection on the Next Window Navigation form.

public event DockSaveCustomToolWindowLayoutDataEventHandler SaveCustomToolWindowLayoutData

Event Type

DockSaveCustomToolWindowLayoutDataEventHandler

Remarks

Use the Writer property to write custom XML data to the layout stream.

public event TabbedMdiWindowEventHandler SelectedDocumentChanged

Event Type

TabbedMdiWindowEventHandler

public event EventHandler SelectedTabbedMdiContainerChanged

Event Type

EventHandler

public event EventHandler ToolWindowDragged

Event Type

EventHandler

public event CancelEventHandler ToolWindowDragging

Event Type

CancelEventHandler

public event EventHandler ToolWindowLayoutLoaded

Event Type

EventHandler

Remarks

This event is raised after a call to LoadToolWindowLayoutFromFile(string) or by setting the ToolWindowLayoutData property.

public event EventHandler ToolWindowLayoutLoading

Event Type

EventHandler

Remarks

This event is raised after a call to LoadToolWindowLayoutFromFile(string) or by setting the ToolWindowLayoutData property.

public event TabbedMdiWindowEventHandler WindowActivated

Event Type

TabbedMdiWindowEventHandler

public event TabbedMdiWindowEventHandler WindowActivating

Event Type

TabbedMdiWindowEventHandler

public event TabbedMdiWindowEventHandler WindowClosed

Event Type

TabbedMdiWindowEventHandler

public event TabbedMdiWindowClosingEventHandler WindowClosing

Event Type

TabbedMdiWindowClosingEventHandler

public event TabbedMdiWindowContextMenuEventHandler WindowContextMenu

Event Type

TabbedMdiWindowContextMenuEventHandler

Remarks

Set the Cancel member of the event arguments to true if the default context menu should not be displayed. This is useful when displaying custom menus.

public event TabbedMdiWindowEventHandler WindowCreated

Event Type

TabbedMdiWindowEventHandler

Remarks

This event is only called once during the lifetime of the window.

public event TabbedMdiWindowEventHandler WindowDisposed

Event Type

TabbedMdiWindowEventHandler

Remarks

This event is only called once during the lifetime of the window.

public event TabbedMdiWindowEventHandler WindowFocused

Event Type

TabbedMdiWindowEventHandler

public event TabbedMdiWindowEventHandler WindowInitializing

Event Type

TabbedMdiWindowEventHandler

Remarks

After this event is raised for a window, the window's IsInitialized property is set to true. This event is only called once during the lifetime of the window.

public event TabbedMdiWindowEventHandler WindowTabToolTipDisplaying

Event Type

TabbedMdiWindowEventHandler