AVEVA CAF API Documenation
Properties  Methods  Events


CommandBarManager Class Members

The following tables list the members exposed by CommandBarManager.

Public Properties
 NameDescription
Public Property Gets or sets the default Customization status for all CommandBars belonging to the CommandBarManager;  
Public Property Gets the collection of CommandBar objects currently managed by the CommandBarManager.  
Public Property Gets a Hashtable which contains controls to use for controls containers.  
Public Property Gets or sets the type of customization.  
Public Property Flag to disable click events.  
Public Property Get or sets a property which controls the enabled state of all CommandBars.  
Public Propertystatic (Shared in Visual Basic) Returns implementation of this class.  
Public Property Informs if a control is currently in edit mode.  
Public Property Gets whether the CommandBarManager is currently in update mode. (i.e. BeginInit() has been called)  
Public Property Gets the CommandBar object that represents the Main Menu Bar.  
Public Property MenuTool OptionSets.  
Public Property Gets the MiniToolbar element.  
Public Property Gets the Ribbon object that represents the Office Ribbon.  
Public Property Gets the collection of RootTool objects currently managed by the CommandBarManager.  
Public Property Gets or sets a value that specifies the style of all CommandBars, PopupMenuTools, and tools.  
Public Property Informs if tooltips should not be shown.  
Top
Public Methods
 NameDescription
Public Method Add menu item in correct position.  
Public Method Create a new OptionSet identified by the specified Key An OptionSet is a set of StateButtonTools (a radio group) where at most one of the tools can can be in the Down (pressed) state.  
Public Method Adds a new UI Customization file.  
Public Method Adds a new UI Customization from the given stream.  
Public Method Adds a set of UI Customization files.  
Public Method ISupportInitialize allows controls to optimize for multiple sets to properties. As a result, you can initialize co-dependent properties or batch set multiple properties at design time. Signal the object that initialization is starting.  
Public Method Signal the object that updating is starting.  
Public Method Clears all XML definitions.  
Public Method Delete any command bars that have no tools.  
Public Method filters Backstage back button  
Public Method ISupportInitialize allows controls to optimize for multiple sets to properties. As a result, you can initialize co-dependent properties or batch set multiple properties at design time. Signal that initialization is complete.  
Public Method Signal that updating is complete.  
Public Method Hide the application menu (Backstage View)  
Public Method Hide the given gallery.  
Public Method Hide the given wheel.  
Public Method Load the saved command CommandBars layout from a settings file.  
Public MethodOverloaded.  Creates the Menus,CommandBars and ContextMenus defined by the loaded UICustomization files.  
Public Method Raise UI loaded event.  
Public Method Rebuild an existing wheel for the given menu.  
Public Method Save the current command CommandBars layout to a settings file.  
Public Method Select the task-pane with the given key.  
Public Method Set the set of directories to search for uic files.  
Public Method Show the application menu (Backstage View)  
Public Method Show the Customization dialog.  
Public Method Show the given galleryTool as a gallery at the current cursor position.  
Public MethodOverloaded.  Shows the mini toolbar to the user.  
Public Method Show the given menu as a wheel at the current cursor position.  
Public Method Suppress ToolTips from showing.  
Public Method Determine if wheel is closed  
Public Method Determine if wheel context menu is shown if so disable tooltips.  
Public Method Determine if wheel is shown if so disable tooltips.  
Top
Public Events
 NameDescription
Public Event Event raised when the commandBar layout is loaded.  
Public Event Event raised when edit mode changes.  
Public Event Event raised when tooltips are shown.  
Public Event Event raised when the UI (Menus,CommandBars and ContextMenus) have finished loading after a call to LoadUI().  
Public Event Event raised just before a wheel is closed.  
Public Event Event raised just before a wheel context menu is shown.  
Public Event Event raised just before a wheel is shown.  
Top
See Also