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


BCGSoft.ControlBars Namespace : CommandBarManager Class

The following tables list the members exposed by CommandBarManager.

Public Constructors
 NameDescription
Public ConstructorCommandBarManager ConstructorOverloaded.   
Top
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)CustomizeManagerSpecifies the customize manager for the command bars.  
Public Fieldstatic (Shared in Visual Basic)DockingFromFloatingTimeOut

Specifies the time lag before tracked docking bar will be docked.

 
Public Fieldstatic (Shared in Visual Basic)InitialCommandBarAutoID

Specifies the default identifier for the command button which will be set on loading and save state if the current identifier of the button is wrong.

 
Public Fieldstatic (Shared in Visual Basic)SerializationCompleteSpecifies if the serialization is complete.  
Top
Public Properties
 NameDescription
Public PropertyAddAllCommandsEntryToCategoriesSpecifies if "AllCommand" category is added to the "Category" list of the "Command" page of the Customize dialog box.  
Public PropertyAddCustomizeButton  
Public PropertyAlwaysSortCategoryListSpecifies if the categories in the category list of the "Command" page of Customize dialog box are sorted alphabetically.  
Public PropertyAlwaysSortCommandListSpecifies if the commands in the command list of the "Command" page of Customize dialog box are sorted alphabetically.  
Public PropertyAutoGroup  
Public PropertyCanShowNewToolbars  
Public PropertyCmdManager  
Public PropertyCommandBarEdgesSpecifies to what sides of the host form command bars can be docked.  
Public PropertyCommandBarsSpecifies the collection of the command bars.  
Public PropertyContainer (Inherited from System.ComponentModel.Component)
Public PropertyCustomImagesSpecifies the set of custom images for the command bars.  
Public PropertyCustomizeButtonIDSpecifies the identifier of the customize command button.  
Public PropertyDesignMode  
Public PropertyDisplayHDPIImagesSpecifies whether toolbar and ribbon elements (toolbar buttons) should display HDPI images. You should set this property to true at runtime if you detect that application is running in HDPI mode and you wish to display special HDPI images on toolbar buttons (toolbar buttons can inherit this setting).  
Public PropertyDockBars  
Public PropertyDockingSencitivitySpecifies the space between the current mouse position and the edge of the host form on which the tracking toolbar becomes docking.  
Public PropertyFillControlSpecifies the control which fills the whole area of the hosts form.  
Public PropertyFirstUserToolbarIDSpecifies the identifier of the custom toolbar first created by user.  
Public PropertyForceShowTooltips  
Public PropertyIsTemporary  
Public PropertyNextButtonIDReturns the identifier of the button to add next.  
Public PropertyNextToolBarIDSpecifies the identifier of the toolbar to locate next.  
Public PropertyParentForm

Sets or gets the parent form for the controls of the command bar manager.

 
Public PropertyRecentDocumentCommandID  
Public PropertyShowShortCutsInToolTipsSpecifies if shortcuts for the commands of the toolbar buttons are displayed in tooltips.  
Public PropertyShowToolTipsSpecifies if tooltips for the toolbar buttons should be shown when mouse hovers the buttons.  
Public PropertySite (Inherited from System.ComponentModel.Component)
Public PropertyStandAloneBars  
Public PropertyStandAloneButtonsSpecifies the collection of the stand alone buttons.  
Public PropertyStandAloneCategories  
Public PropertyUserToolbarCountReturns the number of the user defined toolbar for the command bar manager.  
Public PropertyVisualStyleSpecifies the current visual style of the command bars.  
Public PropertyWindowListButtonIDSpecifies the identifier of the button which contains a list of available windows.  
Top
Protected Properties
Public Methods
 NameDescription
Public MethodAddCommandBarAdds the specified  command bar to the CommandBarManager's collection of the command bars.  
Public MethodAddToItemListOverloaded.   
Public MethodAdjustAllCommandBars  
Public MethodAdjustLayoutSpecifies the docking, size and location of the controls on the parent form.  
Public MethodApplyLayoutReallocates all command bars on the parent form to the docking rows.  
Public MethodAssignButtonGroup  
Public MethodBeginInitStarts the initialization of the command bar managers.  
Public MethodBuildCommandBarMenuOverloaded. Adds to the  pop-up menu items with the names of the command bar from collection and a customize button to the specified popup menu. Serves  for managing a visibility of the command bars and customizing.  
Public MethodClearDragMarkersRemoves drag marker from all of the command bars.  
Public MethodClearItemList  
Public MethodClearSelectionState

Makes all command buttons from the command bar of the current command manager non-pressed and non-selected.

 
Public Methodstatic (Shared in Visual Basic)CreateCustomizeManagerOverloaded. 

Creates a new instance of the customize manager.

 
Public MethodCreateGroupNames  
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 MethodDockCommandBarOverloaded. Docks the command bar to the specified DockEdge or DockStyle, to the specified DockRow.  
Public MethodDockTrackedCommandBarDocks the specified command bar after tracking.  
Public MethodEndInitEnds the initialization of the command bar manager and its command bars.  
Public MethodFindActiveMenuBarIf the command bar manager has a visible menu bar, this menu bar will be returned, otherwise, null reference.  
Public MethodFindAllButtonsReturns an array list of toolbar buttons with the same specified command identifier from all of the command bars.  
Public MethodFindButtonReturns the first occurance of the ToolbarButton with the specified command identifier from the toolbar buttons' collection of the command bars.  
Public MethodFindButtonsInCommandTable  
Public MethodFindCapturedButtonOwnerIf any command button located on the command bars has a capture  the method  FindCaptureButtonOwner returns its parent command bar, otherwise, null reference.  
Public MethodFindCommandBarOverloaded. Returns a command bar from the command bar's collection specified by it's  name.  
Public MethodFindNearestDockBarSpecifies the dock bar and dock row nearest  to the current mouse position on the parent form and defines if this dock bar is located on the outer edge.  
Public MethodFindNextUserToolbarIDCalled by the framework to specify the identifier of the new created user toolbar.  
Public MethodFire_DrawCommandObject

Fires DrawCommandObject event.

 
Public MethodFire_ExecuteCommand

Fires ExecuteCommand event.

 
Public MethodFire_UpdateCmdUIFires UpdateCmdUI event.  
Public MethodFloatCommandBar
Creates a parent floating frame for the specified command bar and places this command bar in it.
 
Public MethodGetDockBarReturns a dock bar from the specified dock edge.  
Public MethodGetFirstExistingDockEdgeSpecifies the first available dock edge to dock the command bar.  
Public MethodGetItemListReturns an item list with an entries to display on the item list  
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 recreate an instance of this CommandBarManager.  
Public MethodGetServiceOverridden. 

Returns an object that represents a service provided by the CommandBarManager.

 
Public MethodGetStateReadWriteReturns a common state serialization for the command bar manager.  
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public Methodstatic (Shared in Visual Basic)IsCustomizeModeSpecifies if the command bars of the command bar manager is in the customize mode.  
Public MethodIsInitProcessGets a value that indicates whether the command bar manager is during the process of the initialization.  
Public MethodIsPopupMenuOpenedSpecifies if any toolbar button of any command bar has an open pop-up menu.  
Public MethodLoadCommonLayout

Loads the specified properties for the command manager and dock manager from the xml-files describing the earlier layout state. 

 
Public MethodLoadStateLoads a state of the command bars from the specified file stream.
The state should be previously saved by the SaveState function.  
Public MethodLoadStateDefaultLoads the state for the command bars from the specified xml-file.  
Public MethodLoadStateFromFileLoads state from file. Can be used in conjunction with SaveStateToFile.  
Public MethodOnAfterShowPopupMenuRaises the AfterShowPopupMenu events which occurs when the popup menu is shown.  
Public MethodOnBeforeShowPopupMenuRaises the BeforeShowPopupMenu events which occurs when the popup menu is  about to show.  
Public MethodOnUserPreferenceChanged  
Public MethodRemoveFromItemList  
Public MethodRenumberItemList  
Public MethodSaveCommonLayout

Saves the specified properties of the command manager and the dock manager to the xml-files describing their  layout state. 

 
Public MethodSaveStateSaves a state of the command bars to the specified file stream.  
Public MethodSaveStateDefaultSaves a state of the command bars to the specified xml-file.  
Public MethodSaveStateToFileSaves state to a file.  
Public MethodSetCmdManagerSets the specified  command manager to the command bar manager.  
Public MethodSetRelatedToolbarsRelates the toolbar from the CommandBarManager to the specified form.  
Public MethodShouldSerializeCustomImagesSpecifies if the custom images should be serialized.  
Public MethodShouldSerializeFillControl
Specifies if the fill control should be serialized.
 
Public MethodShouldSerializeIsTemporary  
Public MethodShowCustomizeDialogCreates a new customize dialog box at the specified point.  
Public MethodSyncCommandObjectsSynchronizes command objects with any source.  
Public MethodToString (Inherited from System.ComponentModel.Component)
Public MethodTrackCommandBar

If the bar is floating and the parent form of controls is not NULL, the bar will be moved to NewX points right and to NewY points down.
Call this member function to display the command bar anywhere on the screen.

 
Public MethodUpdateStandAloneBarsSpecifies the size of the stand alone command bars.  
Top
Protected Methods
Public Events
 NameDescription
Public EventAfterShowPopupMenuOccurs when the popup menu is shown.  
Public EventBeforeShowPopupMenuOccurs when the popup menu is about to be displayed.  
Public EventDeserializeState  
Public EventDisplayHDPIImagesPropertyChanged  
Public EventDisposed (Inherited from System.ComponentModel.Component)
Public EventDrawCommandObjectOccurs when the command bar is painting.  
Public EventExecuteCommandOccurs to execute a set of commands related to any buttons from command bars.  
Public EventRelatedBarSetOccurs when the set of toolbars from the specified form is applied to the command manager.  
Public EventSerializeState  
Public EventUpdateCmdUIUpdates the state of the commands from the command bars when any events occurs.  
Top
See Also

Reference

CommandBarManager Class
BCGSoft.ControlBars Namespace

Send Feedback