ArcFM Desktop Developer Guide
DockPaneBase Class Members
| Miner.Windows Assembly > Miner.Windows.Docking Namespace : DockPaneBase Class |
The following tables list the members exposed by DockPaneBase.
| Name | Description | |
|---|---|---|
 | Caption | Returns/sets the caption for the pane. |
| Closed | Returns/sets whether the pane is closed. |
| DockAreaPane | Returns the root DockAreaPane ancestor that contains this pane. |
| DockedState | Returns whether the pane is floating or docked to a container. |
| HasSettings | Returns whether a PaneSettings object has been created for the Settings property of the pane. |
| Index | Returns the index of the current pane in the Panes collection of the pane's parent. If the pane has no parent, then returns -1. |
| IsActive | Returns/sets whether the current pane contains the active control or has a child pane containing the active control. |
| IsInitialized | Returns whether the InitializePane event has been fired for the pane. |
| IsSelectedTab | Returns/sets whether the pane is the selected item in a tab style group or sliding group. If the pane does not have a parent pane, this property returns false. |
| IsVisible | Returns whether the pane is currently displayed. When panes are closed they are hidden, and this property will return false. |
| Key | Returns/sets the unique string identifier for this pane in its collection. |
| Maximized | Returns/sets whether the pane is maximized. |
| MaximumSize | Returns/sets the maximum size of the pane. This property specifies the maximum height and/or width that the pane should not exceed during resizing. |
| Minimized | Returns/sets whether the pane is minimized. |
| MinimumSize | Returns/sets the minimum size of the pane. This property specifies the minimum height and/or width for the pane. |
| NestDepth | Returns the level of nesting occupied by the current pane. This property specifies how deeply nested the pane is within other panes. For top-level (DockArea) panes, NestDepth returns 0. A pane nested inside a top-level pane will return 1. |
| Parent | Returns the parent of the current pane. This property returns null if the pane does not have a parent. |
| ParentDocked | Returns the parent DockGroupPane that contains this pane when it is docked. |
| ParentFloating | Returns the parent DockGroupPane that contains this pane when it is floating. |
| Settings | Returns the PaneSettings object so that its properties and methods can be returned/set. |
| Size | Returns/sets the value used to determine the size of the pane in proportion to other panes in the same docking area. |
| TabImage | Returns/sets the image to be displayed on the tab associated with this pane. |
| TabText | Returns/sets the text for the tab associated with this pane. If this property is a blank string, the Caption property will be used. |
| TabTooltip | Returns/sets the tooltip displayed when the mouse is over the pane's tab. |
| TooltipCaption | Returns/sets the tooltip displayed when the mouse is over the pane's caption. |
| Name | Description | |
|---|---|---|
 | Activate | Activates the control contained within this pane. |
| Close | Overloaded. Closes this pane but not any of its children. |
| Dock | Overloaded. Docks the pane and its children to the DockAreaPane it previously occupied. |
| Float | Overloaded. Places the pane and any of its child panes into a floating window. |
| Pin | Pins all of the child panes. |
| RepositionToGroup | Overloaded. Repositions the pane into a new group. |
| RepositionToPane | Repositions this pane relative to the specified pane. |
| Show | Ensures that the pane is displayed by updating the Closed property of itself and its parent chain. |
| ToggleDockState | Toggles the pane and its child panes between the last docked and floating states. Invoking this method is equivalent to double-clicking on the pane's title bar. |
| Unpin | Unpins all of the DockableControlPane descendant panes. This method cannot be invoked on a floating AcmeDockAreaPane pane. |
