ArcFM Engine Developer Guide
Dock(Boolean) Method


If true, each floating pane will be returned to the docked area from which it originated; if false, the panes will remain together as a group when docked.
Docks the pane and its children to the DockAreaPane it previously occupied.
Syntax
'Declaration
 
Public Overloads Sub Dock( _
   ByVal maintainPreviousState As Boolean _
) 
'Usage
 
Dim instance As DockPaneBase
Dim maintainPreviousState As Boolean
 
instance.Dock(maintainPreviousState)
public void Dock( 
   bool maintainPreviousState
)

Parameters

maintainPreviousState
If true, each floating pane will be returned to the docked area from which it originated; if false, the panes will remain together as a group when docked.
Remarks
Since panes can be taken from multiple docking areas and grouped together into a single floating pane, the maintainPreviousState parameter is used to determine how the grouped floating panes should be re-docked. When maintainPreviousState is set to true, the previous dock state of each pane is preserved, and docking the group will cause all of its panes to re-dock at their original locations. The panes can be forced to remain together (and possibly change their docking location) when the floating group is docked by specifying false for the maintainPreviousState parameter.

If this method is invoked for a floating pane that has never been docked, the pane will dock along the right side of the client area.

Requirements

Target Platforms: Windows XP SP3 (32-bit and 64-bit), Windows 7 (32-bit and 64-bit)

Not all Operating Systems are supported on all products. Visit the ArcFM Solution Supported Versions page for full details.

See Also

Reference

DockPaneBase Class
DockPaneBase Members
Overload List

 

 


Send Comment