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


The following tables list the members exposed by LayoutController.

Public Constructors
 NameDescription
Public ConstructorLayoutController Constructor  
Top
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)m_instanceSpecifies the instance of the LayoutController.  
Public Fieldm_managersRepresents a hashtable where the key is a form and a value is an entry associated with it.  
Public Fieldm_rectInnerSpecifies the boundaries of the area where layout takes place.  
Top
Public Properties
 NameDescription
Public PropertyInnerRectSpecifies the boundaries of the area where layout takes place.  
Public PropertyLoadingStateSpecifies if the LayoutController is loading the information from the file stream at current moment by the method LoadState. Called by the framework to report about the loading state by DockManager or CommandBarManager and to cancel the adjusting of layout on the dockbar row.  
Top
Public Methods
 NameDescription
Public MethodAdjustLayoutOverloaded. 
Places in order the size and location of docking panes and control bars on the specified component.
 
Public MethodDisposeOverloaded.   
Public MethodEnableBasicMDITabs  
Public MethodEnableLayoutSets available or disabled the adjusting of the layout by the LayoutController of the specified form. Called by the framework when it is necessary to cut off this layout and turn it on.  
Public MethodEnableMDITabs
Allows to place MDIChild forms in the TabControl  for a MDIContainer's form and to adjust their layout. 
 
Public MethodEntryFromObjectGets an Entry object related to the specified object and transforms it to the form, if the specified object has a type of System.Windows.Forms.Form.  Otherwise, returns null reference. Called by the framework to get an entry and related form to adjust its layout.  
Public MethodGetCommandBarManangerReturns the child CommandBarManager object for the specified form.  
Public MethodGetDockManagerReturns the child DockManager object for the specified form.  
Public Methodstatic (Shared in Visual Basic)GetInstanceif the object of the LayoutController does not exist, this function creates a new instance of the LayoutControllerObject and returns it, otherwise returns the existing instance of the LayoutObject. Called by the framework when it is necessary to apply to the current instance of the LayoutController.  
Public MethodGetMdiClientReturns the control which fills the specified form. Called by the framework to get an access to the MDIClientArea of the MDIContainer form.  
Public MethodGetMdiClientListener  
Public MethodGetMdiTabsOptionsReturns the MDITabsOptions for the specified form. Called by the framework to get an access to the MDITabsOption object of the MDIContainer form.  
Public MethodGetStatusBarControlReturns the status bar from the specified form. If the specified form has no status bar the null reference will be returned.  
Public MethodIsBasicMDITabsEnabled  
Public MethodIsLayoutEnabledSpecifies if it is available to adjust the layout of the specified form by the LayoutController instance.  
Public MethodIsMDITabsEnabledIndicates if the MDITabsEnabled mode is set for the specified MDIContainer. It means that its MDIChild windows can be placed into the tabbed windows. Called by framework to check the availability of the MDITabsEnabled mode.  
Public MethodLoadStateOverloaded. Loads a state for the specified  form from the specified file stream.
The state should be previously saved by the SaveState function.  
Public MethodRegisterComponentRegisters such components as CommandBarManager, DockManager and MDITabsOption for the specified form. Called by the framework on setting these component for a specified form.  
Public MethodSaveStateOverloaded. Saves a state of the LayoutController to the specified files.  
Public MethodSetRedrawDisables or enables drawing in the specified form.  
Public MethodSetupEventHandlersAdds or removes from the specified form event handlers defined in the LayoutController class for such events for System.Windows.Forms.Form object as Resize, ControlAdded, ControlRemoved, Disposed, SystemColorChanged. Called by the framework when the Layout Instance registers and unregisters component, adds new entry and related form to entries' collection.  
Public MethodSyncVisualStyleRetrieves the Visual style from the specified CommandBarManager and sets it for CommandBarManagers of others form which registered in the LayoutController. Called by the framework on setting new visual style for any CommandBarManager.  
Public MethodUnRegisterComponentUnregisters and removes such components as CommandBarManager, DockManager and MDITabsOption from the specified form. Called by the framework on setting these components for a specified form. Called by the framework on setting new parent form for CommandBarManager or DockManager object.  
Top
Protected Methods
Public Events
 NameDescription
Public EventLayoutOccurs when the size and location of internal controls of the form are assigned.  
Top
See Also

Reference

LayoutController Class
BCGSoft.ControlBars Namespace

Send Feedback