Controlling Window Capabilities
The Dock controls provide the most detailed control of window capabilities in a product of its type. Window capabilities can be set on a global level via properties on the DockManager component, or can be set on an individual basis via properties on each document or tool window instance that override the global defaults.
Global Defaults
Global defaults can be set to affect window capabilities. The values can be overwritten in each window instance however these settings will be used if no overrides are set. The following properties are all found on the DockManager component and control the global default settings:
| Member | Description |
|---|---|
| DocumentWindowsCanClose Property | Gets or sets the global setting for whether document windows can be closed. |
| ToolWindowsCanAttach Property | Gets or sets the global setting for whether tool windows may be attached to another tool window. |
| ToolWindowsCanAutoHide Property | Gets or sets the global setting for whether tool windows may be placed in auto-hide mode. |
| ToolWindowsCanBecomeDocuments Property | Gets or sets the global setting for whether tool windows may be placed in a document state. |
| ToolWindowsCanClose Property | Gets or sets the global setting for whether tool windows can be closed. |
| ToolWindowsCanDockHostBottom Property | Gets or sets the global setting for whether tool windows may be docked to the bottom of the host container control. |
| ToolWindowsCanDockHostLeft Property | Gets or sets the global setting for whether tool windows may be docked to the left of the host container control. |
| ToolWindowsCanDockHostRight Property | Gets or sets the global setting for whether tool windows may be docked to the right of the host container control. |
| ToolWindowsCanDockHostTop Property | Gets or sets the global setting for whether tool windows may be docked to the top of the host container control. |
| ToolWindowsCanDrag Property | Gets or sets the global setting for whether tool windows may be dragged to another location. |
| ToolWindowsCanFloat Property | Gets or sets the global setting for whether tool windows may be contained in a floating window. |
| ToolWindowsHaveOptions Property | Gets or sets the global setting for whether tool windows have more options available than the standard options. |
| ToolWindowsHaveTitleBars Property | Gets or sets the global setting for whether tool windows display a title bar when docked. |
Instance Settings
Instance settings are specific to a single instance of a tool or document window. Boolean values use a DefaultableBoolean enumeration value to indicate whether they should use the global default value, or force a true/false instance setting.
These are the settings found on the TabbedMdiWindow class that provide instance settings to each tool window and document window.
| Member | Description |
|---|---|
| CanClose Property | Gets or sets whether the window may be closed. |
These are the settings found on the ToolWindow class that provide instance settings to each tool window.
| Member | Description |
|---|---|
| CanAttach Property | Gets or sets whether the tool window may be attached to another tool window. |
| CanAutoHide Property | Gets or sets whether the tool window may be placed in auto-hide mode. |
| CanBecomeDocument Property | Gets or sets whether the tool window may be placed in a document state. |
| CanDockHostBottom Property | Gets or sets whether the tool window may be docked to the bottom of the host container control. |
| CanDockHostLeft Property | Gets or sets whether the tool window may be docked to the left of the host container control. |
| CanDockHostRight Property | Gets or sets whether the tool window may be docked to the right of the host container control. |
| CanDockHostTop Property | Gets or sets whether the tool window may be docked to the top of the host container control. |
| CanDrag Property | Gets or sets whether the tool window may be dragged to another location. |
| CanFloat Property | Gets or sets whether the tool window may be contained in a floating window. |
| HasOptions Property | Gets or sets whether the tool window has more options available than the standard options. |
| HasTitleBar Property | Gets or sets whether the tool window displays a title bar when docked. |