ArcFM Engine Developer Guide
DockControlPane Class Members
Properties  Methods 


The following tables list the members exposed by DockControlPane.

Public Properties
 NameDescription
Public PropertyCaptionReturns/sets the caption for the pane. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyClosedReturns/sets whether the pane is closed. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyControlReturns/sets the Control that the DockControlPane encloses.  
Public PropertyDockAreaPaneReturns the root DockAreaPane ancestor that contains this pane. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyDockedStateReturns whether the pane is floating or docked to a container. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyFlyoutSizeReturns/sets the size of the flyout window. Depending on where the unpinned pane is docked, only the width or height is used.  
Public PropertyHasSettingsReturns whether a PaneSettings object has been created for the Settings property of the pane. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyIndexReturns the index of the current pane in the Panes collection of the pane's parent. If the pane has no parent, then returns -1. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyIsActiveOverridden. Returns/sets whether this control pane contains the active control.  
Public PropertyIsFlyoutPaneDisplayReturns whether the pane is unpinned and currently displayed in a flyout. This property returns false when the pane is collapsed into the tab area.  
Public PropertyIsInitializedReturns whether the InitializePane event has been fired for the pane. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyIsPinnedReturn whether the pane is currently pinned.  
Public PropertyIsSelectedTabReturns/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. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyIsVisibleOverridden. Return whether the pane is currently displayed. When panes are closed they are hidden and this property will return false.  
Public PropertyKeyReturns/sets the unique string identifier for this pane in its collection. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyMaximizedReturns/sets whether the pane is maximized. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyMaximumSizeReturns/sets the maximum size of the pane. This property specifies the maximum height and/or width that the pane should not exceed during resizing. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyMinimizedReturns/sets whether the pane is minimized. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyMinimumSizeReturns/sets the minimum size of the pane. This property specifies the minimum height and/or width for the pane. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyNestDepthReturns 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. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyOriginalControlBoundsReturn/set the bounds of the control when the Control property was first set.  
Public PropertyParentReturns the parent of the current pane. This property returns null if the pane does not have a parent. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyParentDockedReturns the parent DockGroupPane that contains this pane when it is docked. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyParentFloatingReturns the parent DockGroupPane that contains this pane when it is floating. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertySettingsReturns the PaneSettings object so that its properties and methods can be returned/set. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertySizeReturns/sets the value used to determine the size of the pane in proportion to other panes in the same docking area. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyTabImageReturns/sets the image to be displayed on the tab associated with this pane. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyTabTextReturns/sets the text for the tab associated with this pane. If this property is a blank string, the Caption property will be used. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyTabTooltipReturns/sets the tooltip displayed when the mouse is over the pane's tab. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public PropertyTooltipCaptionReturns/sets the tooltip displayed when the mouse is over the pane's caption. (Inherited from Miner.Windows.Docking.DockPaneBase)
Top
Public Methods
 NameDescription
Public MethodActivateOverridden. Activate the control contained within this pane.  
Public MethodCloseOverloaded. Closes this pane but not any of its children. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public MethodDockOverloaded. Docks the pane and its children to the DockAreaPane it previously occupied. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public MethodFloatOverloaded. Places the pane and any of its child panes into a floating window. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public MethodFlyoutOverloaded. Display an unpinned pane from the UnpinnedTabArea where the tab for the pane is displayed.  
Public MethodPinOverridden. Reattaches the pane to its docked parent pane.  
Public MethodRepositionToGroupOverloaded. Repositions the pane into a new group. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public MethodRepositionToPaneRepositions this pane relative to the specified pane. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public MethodShowEnsures that the pane is displayed by updating the Closed property of itself and its parent chain. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public MethodToggleDockStateToggles 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. (Inherited from Miner.Windows.Docking.DockPaneBase)
Public MethodUnpinOverridden. Unpin all of the DockableControlPane descendant panes. This method cannot be invoked on a floating AcmeDockAreaPane pane.  
Top
See Also

Reference

DockControlPane Class
Miner.Windows.Docking Namespace

 

 


Send Comment