BCGControlBar Library for .NET
DockManager Class Members
Fields  Properties  Methods  Events


The following tables list the members exposed by DockManager.

Public Constructors
 NameDescription
Public ConstructorDockManager ConstructorOverloaded.   
Top
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)AutoHideEdgeMapRepresents an array of the DockStyles which can be applied as AutoHide edges.  
Public Fieldstatic (Shared in Visual Basic)DefaultAutoHidePanelHeightRepresents the height in horizontal layout and width in vertical layout of the AutoHidePanel. The default value is 21.  
Public Fieldstatic (Shared in Visual Basic)LoadStateSilentMode  
Public Fieldstatic (Shared in Visual Basic)MdiTabControl  
Public Fieldstatic (Shared in Visual Basic)MinSplitterTrackSpacing  
Public Fieldstatic (Shared in Visual Basic)ThrowWrongStateException  
Top
Public Properties
 NameDescription
Public PropertyAllDockingPanes  
Public PropertyAutoHideEdgesSpecifies the edge of the form where docking panes can be autohide.  
Public PropertyAutoHidePanels  
Public PropertyContainer (Inherited from System.ComponentModel.Component)
Public PropertyCurrentRolledOutBar  
Public PropertyDisableAdjustLayout  
Public PropertyDockedBars  
Public PropertyDockedObjects  
Public PropertyDockingTypeSpecifies the type of markers used on docking process.  
Public PropertyEnableWindowPositionMenuIndicates a value if the "WindowPosition" context menu can be displayed  for docking panes from this DockManager.  
Public PropertyFloatingFrames  
Public PropertyInnerDockingBounds  
Public PropertyInternalDockingType  
Public PropertyInternalTracker  
Public PropertyLayoutStream  
Public PropertyOuterDockingBounds  
Public PropertyOverlapAutoHideButtonsIndicates a value whether the AutoHideButtons on the AutoHidePanel should be overlapped by each other.  
Public PropertyParentFormGets the form that the DockManager is assigned to.  
Public PropertyRestoredHiddenPanes  
Public PropertyRestoredMDITabbedPanes  
Public PropertySite (Inherited from System.ComponentModel.Component)
Public PropertyTrackingMode  
Top
Protected Properties
Public Methods
 NameDescription
Public MethodAddDockedBarCall this member function to register any docking pane within dock manager. Adds the specified docking pane to the collection of the docked bar.  Called by the framework on docking any pane within the parent form.  
Public MethodAddDockingPaneCall this member function to register any docking pane within dock manager. It adds the specified docking pane to the all docking pane collection of the dockmanager. Now the specified docking pane will be managed by the dockmanager.  
Public MethodAddDockingPaneToTabbedDocumentsPuts the specified docking pane to the tabbed MDI-child form within the MDIContainer form. It is possible only if the parent form  is MDIContainer and EnableMDITabs mode for  the current layout controller instance is available.  
Public MethodAdjustAssemblyVersionSpecifies the current identifier of the assembly version. Called by framework on loading state from and saving to xml-file.  
Public MethodAdjustDockingLayout

Adjusts the Layout of the docking panes, which belongs to the dock manager. Called by the framework when the state of the any docking pane is changed.

 
Public MethodAdjustPaneLayoutRecalculates the size and position of the controls inside internal client area  and caption's button on the caption of the docking panes which belong to this dockmanager.  
Public MethodApplyLayoutLoads an information about the layout of the dockmanager using SOAP formatter.  
Public MethodAttachToTabWnd

 Returns new docking pane, which will have a new tab control. On this tab control attached panes will be arranged.

 
Public MethodAutoHideAllSets autohide mode for all of the docking pane belongs to the current dockmanager.  
Public MethodBeginInitBegins the initialization of the DockManager that is used on a form or used by another component. The initialization occurs at run time.  
Public MethodBringToFrontStaticControlsBrings all controls on the parent form of the docking manager in front of controls which fill all the client area of the parent form according to it's current dockstyle. Called by the framework when the autohide mode for the docking pane is set.  
Public MethodCalcExpectedDockedRectOverloaded. Called by the framework on tracking docking pane. Returns the object of the DockInfo class with an information about the expected dock state and layout of the docking pane  when the mouse cursor is located on the specified position during the tracking.  
Public MethodCreateAutoHidePanel

Called by the framework to setting autohide edges for a dockmanager. Creates an autohide panel  with definite dock edge.

 
Public MethodCreateMiniFrameCreates miniframe window for the parent form of the dockmanager with the boundaries of the specified rectangle, adds it to the  miniframe's collection of the dockmanager.   Called by the framework when any docking pane of this dockmanager gets the floating state.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDisposeOverloaded. Overridden.   
Public MethodDisposeUnreferredControlWrapperCalled by the framework on setting new control wrapper.  Checks if the specifies control wrapper does not belong to any docking pane and then if such a docking pane was not found it will be removed.  
Public MethodDisposeUnreferredMiniFrameCalled by the framework on setting recent miniframe for the docking pane or saving its state. Checks if any docking pane from the docking pane's collection of current dockmanager is a child of the specified miniframe. If there is no such a docking pane, the specified  miniframe will be removed.  
Public MethodDisposeUrefferedContainerCalled by the framework on setting recent dock for the docking container or saving the state of the docking pane. Checks if any docking pane from the docking pane's collection of current dockmanager has the specified docking container. If there is no such a docking pane, the specified  docking container will be destroyed.  
Public MethodDockControlOverloaded. Docks the specified control within the parent form.  
Public MethodDockControlBarToRecentPosDocks the specified docking pane to the docking container or as tabbed document to the docking container which it has before the current state. Called by framework on setting visibility and autohide mode for the docking pane.  
Public MethodDockingControlFromPointif the boundaries of any docking container from the docked objects' collection of the DockManager or any miniframe window from the floating frame collection of the current dockmanager contains the specified point, returns this control. If such a control was not found or found control is specified in parameter "exclude",the function returns null value. Called by the framework on tracking the docking pane with smart markers to define it's current state.  
Public MethodDockMiniFrameOverloaded. Called by the framework when it is necessary to  dock any control located in the miniframe, for example, on mouseUp event of the miniframe. The information about the layout and the state of the docking pane you can get from the parameter "DockInfo".  
Public MethodDockMiniFrameToRecentPosDocks the specified docking pane located in miniframe window to the docking container which it has before the current state. Called by framework on mouse double click on the miniframe window.  
Public MethodEndInitEnds the run-time initialization of the dock manager that is used on the form or by another component.  
Public MethodEndTrackCalled by the framework to complete the tracking of any docking pane and to inform about it.  
Public MethodFindActiveDockingPaneReturns the first  active docking pane from the all docking pane's collection of the DockManager.  If the parent form is a MDI container and its MDIClient area is not null, the active docking pane from the MDIClient area will be returned.  
Public MethodFindAutoHidePanelReturns the AutoHidePanel from the AutoHidePanel's collection of the DockManager which related to the specified docking pane. An AutoHideButton related to this docking pane will be passed into the parameter "buttonOut". Called by the framework on setting autohide mode for the docking pane.  
Public MethodFindDockingContainerReturns the docking container for the specified control. If the target container was not found the null reference will be returned.  Called by the framework on docking any control, attaching it to the tabbed windows.  
Public MethodFindDockingPane

Finds the docking pane in the docking panes' collection of the DockManager which has a name from parameter findByName or its embedded control has a name  from parameter findByEmbeddedControlName.

 
Public MethodFloatDockingPaneOverloaded. 

Places a specified docking pane to the miniframe created within the specified boundaries and returns it. If the docking pane can not be added to the miniframe the null reference will be returned. Called by the framework when it is necessary to set floating state for the specified docking pane.

 
Public MethodFloatDockingPaneOnRecentFramePlaces the specified docking pane located in the docking container or the tabbed group to the floating miniframe windows which was parent for it before the current state. Called by framework on mouse double click on the docking pane and on changing PaneState property.  
Public MethodGetAssemblyVersionGets the number of currently loaded assembly's version  where the DockManager is defined. Called by the framework on serialization of the data to the xml-file.  
Public MethodGetAutoHidePanelReturns an autohide panel from the autohide panels' collection with the specified docking edge. If such an autohide panel will not be found the null reference will be returned. Called by the framework when it is necessary to find the AutoHidePanel. It is used on setting Autohide mode, adjusting the layout of the controls and docking any control within the parent form.  
Public MethodGetDebugPercents  
Public MethodGetDockedObjectReturns a docking container from docked object collection which has a specified index. Called by the framework on adjusting the layout of the docking container by the LayoutController.  
Public MethodGetDockedObjectsCountReturns the amount of the docking container in the docking object's collection. Called by the framework on adjusting the layout of the docking container by the LayoutController.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetObjectDataGets serialization information with all of the data needed to reinstantiate the DockManager.  
Public MethodGetServiceOverridden. 

Gets the service object of the specified type, if it is available.

 
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInitTrackerInitializes the tracking of the specified control.  This function creates a tracker for the tracked control according the position of mouse cursor over it. If the control was docked before starting the tracking it becomes floating. This function is called by the framework on mouse events which cause the begin of tracking.  
Public MethodIsDesignMode

Retrieves a value that indicates whether the DockManager is currently using the Microsoft Visual Studio 2005 Editor.

 
Public MethodLoadCommonLayoutLoads the information from the specified xml-files which contains some parameters about the state of command bars and docking panes. This information can be written to this file by the SaveCommonLayout function. This function is usually called when the application is about to open.
 
Public MethodLoadStateLoads a state of the docking objects  from the specified file stream.
The state should be previously saved by the SaveState function.  
Public MethodLoadStateDefaultLoads a state of the DockManager from the specified file.  
Public MethodLoadStateFromFile  
Public MethodPutDockingPaneOnMiniFramePlaces the specified docking pane to the specified miniframe. Called by the framework on making any docking pane floating.  
Public MethodRaiseAutohidePaneEvent  
Public MethodRaiseCloseDockingPane  
Public MethodRecreate
Recreates the DockManager from the specified DockManager using serialization info.
 
Public MethodRemoveDockingPaneFromTabbedDocumentsIf the docking pane is located in the tab MDIChild form, this function removes this form and places the docking pane on its old position and makes it focused. Called by framework on changing the pane state from the TabbedDocument state to another one.  
Public MethodReplaceDockingPaneReplaces the one docking pane to another within the docking container or the miniframe window and in accordance in the docked bar's collection of the DockManager. Called in framework, for example, to replace the docking pane by its clone containing tab control.  
Public MethodSaveCommonLayoutSaves the state and layout of the command bars and docking panes on the parent form to the specified xml-files. This function is usually called when the parent form is about to close.  
Public MethodSaveStateSaves a state of the DockManager to the specified file stream.  
Public MethodSaveStateDefaultSaves a state for the DockManager to the specified xml-file.  
Public MethodSaveStateToFile  
Public MethodSetAutoHideModeSwitches the specified docking pane to the autohide mode or back to the regular docking mode.  
Public MethodShouldSerializeLayoutStreamSpecifies if the current LayoutStream should be serialized. By delault It should be serialized always when the LayoutStreamObject is not null.  
Public MethodShouldSerializeRestoredHiddenPanesSpecifies if the restored hidden docking panes should be serialized. In default implementation they should not be serialized .  
Public MethodShouldSerializeRestoredMDITabbedPanesSpecifies if the restored MDITabbed panes should be serialized. In default implementation  they should not be serialized .  
Public MethodToString (Inherited from System.ComponentModel.Component)
Public MethodTrackOverloaded. Tracks any  control to the specified position.  
Public MethodUndockPaneRemoves the specified docking pane from its docking container and from the collection of the docked bar.  
Public MethodWrapControlCreates a docking pane for the specified control and place it to this docking pane. Called by the framework on docking any control which is not a type of the DockingPane.  
Top
Protected Methods
Public Events
 NameDescription
Public EventAddDockingPaneToMDITabsThis event is raised when a DockingPane was added to MDI documents.  
Public EventAutohidePaneRaised when a DockingPane is switched to auto hide mode.  
Public EventCloseDockingPaneRaised when a dockign pane is being closed. The event is cancellable, so you you can set CloseDockingPaneEventArgs.Cancel = true in order to prevent a docking pane from being closed.  
Public EventDisposed (Inherited from System.ComponentModel.Component)
Public EventDockPane

Raised when a DockingPane was docked.

Use DockingPane.CurrentDock property to determine the side of the parent form's client area the pane is docked to.

 
Public EventFloatPaneRaised when a DockingPane has been floated.  
Public EventTabDockingPaneRaised when a DockingPane has been tabbed.  
Top
See Also

Reference

DockManager Class
BCGSoft.ControlBars Namespace

Send Feedback