BCGControlBar Library for .NET
BCGSoft.ControlBars Namespace
Inheritance Hierarchy
Classes
 ClassDescription
ClassAutoHideButton Inherits from the Windows.Forms.Control and implements such interfaces as IResizeTarget, ISerializable. Provides the functionality of a button that triggers show and hide of a docking pane that was switched to autohide mode.  An AutoHideButton object is instantiated automatically by the framework when a docking pane is switched to autohide mode. An autohide button is disposed automatically by the framework when a docking pane is switched to normal docked mode.
ClassAutoHidePanel

Inherits from the Windows.Forms. Panel and implements such interfaces as ISupportCustomLayout, ISerializable.
Autohide panels host autohide buttons. Autohide panels are created by dock manager when you set the AutoHideEdges property.

ClassBaseDockingObject A base class for ControlWrapper and DockTable. Implements interface ISerializable.
Contains a set of function for managing the state, size and location of the docking object, their serialization.
ClassBeforeAddFontEventArgs Provides data for a cancelable event, which occurs before a font is added to a font combo box.
ClassButtonGroupPanel Represents an embedded control for ToolbarButtonGroup where ToolbarButtons are located.
ClassCalendarPopupMenu  
ClassCaptionCommandButton Inherits from System.Windows.Forms.Control. CaptionCommandButton is a system button displayed on the rightmost side of the floating toolbar's  or docking pane’s title bar.
ClassCloseDockingPaneEventArgs Provides data for a cancelable event, which occurs when a docking pane is being closed.
ClassColorButton A ColorButton control inherits from the ToolbarMenuButton of the  BCGSoft.ControlBars namespace. It implements interface ISerialazable. This button can be added to the toolbar or menubar. Allows to pick a color to change a fontcolor or backcolor on another control. By default it behaves as a push button that opens a popup bar with the  small buttons and custom color picker. When a new color is selected the ColorButton automatically reflects the changes and displays the selected color.
ClassColorGalleryButton Implements a button, which displays a color Gallery.
ClassColorGalleryControl  
ClassCommandBar

Base class for all command bars.
A command bar implements functionality of  control which can be either floated in host popup window, or docked to edge of parent form. In docked state a command bar object resides on "dock row". Also, a command bar control can be placed on another control. A command bar object must be added to  a CommandBarManager component in order to enable docking and floating capabilities.

A command bar object fires the CommandSent event, which notifies subscribers that a specific command assigned to one of elements of a command bar should be executed.
You have to inherit from this class if you wish to create custom command bars.

ClassCommandBarCollection

Inherits CollectionwithEvents class of the BCGSoft.Shared namespace. The collection of command bars is maintained by CommandBarManager. Whenever you call CommandBarManager, a command bar is added to this collection.

ClassCommandBarFrame Inherits Panel of System.Windows.Forms,  implements interface ISupportCustomLayout.
Represents a parent control for the command bar. It is created when the floating mode for the command bar is set and destroyed  when the floating mode for it is unset. The size, location and visibility of the CommandBarFrames depends on the child command bar.
ClassCommandBarManager

The CommandBarManager component manages all floating and docked CommandBar objects. You should add this component to each Form you want to enable dockable and floating command bars for.
You specify to what sides of the host form command bars can be docked by setting the CommandBarEdges property.
You can add command bars to be managed by CommandBarManager using DockCommandBar and FloatCommandBar members.
CommandBarManager handles the application idle state and fires UpdateCmdUI event which allows subscribers update the current UI command state. For example, toolbars can update checked or disabled buttons. 
By changing the VisualStyle property you can specify look & feel of command bars managed by CommandBarManager.
CommandBarManager can save and load state to/from a stream using SaveState/LoadState methods.

ClassCommandEntry  
ClassCommandEntrySerializeHelper  
ClassCommandManager  
ClassContextMenuButton Inherits ToolbarMenuButton of the BCGSoft.ControlBars namespace. A "root" for context popup menu. Manages an instance of the context menu, lets open and close it, defines it’s location, manage it’s PopupMenuButton collection. It is created automatically in design view when we click on the “Add menu” of the ContextMenuManager pane. Using this class we can display context menu in run-time.
Context menu represents a shortcuts menu which can be displayed by click of the right mouse button over  the control. Context menu is used to combine ToolbarComboBox, ToolbarEditBox and ToolbarMenuButton that have a commands for managing current control. For example, you can use context menu for adding to or getting data from the clipboard, finding a text, changing a font.
ClassContextMenuManager

Inherits Component class of System.ComponentModel namespace.  Manages a collection of the ContextMenu buttons that are typically used to show context menu. 

ClassControlWrapper  
ClassCurrentColorChangedEventArgs  
ClassCustomizeButton

Inherits from  ToolbarMenuButton, implements ISerializable interface. This button is added to the toolbar as in docking as in floating mode if it’s property HasCustomizeButton is true.   In it’s popup menu will be shown Quick Customize button and command buttons which can not be placed to the toolbar because of the size of the parent form.

ClassCustomizeButton.CustomizeDialogButton  
ClassCustomizeDialog

Inheritied from the Form class of the System.Windows.Forms namespace. The Customize dialog allows you to create custom toolbars, add and remove items from existing toolbars and change the appearance of the toolbars displayed. We can customize shortcuts keys for command. You can access this dialog box by selecting Customize button on the toolbar.
Customize Dialog Box has such tabs as “Command”, “Toolbar”, “Keyboard” and “Options”.
Command:
Displays a set of commands which can be added to the CommandBars.  Categories list  displays the commands that are shown in the command list box. Commands list specifies commands and it’s images for the selected category. If you want to  place this one of the commands  you have to drag it from the commands list to the customizable toolbar. Description field contents an information about selected category.

Toolbar:
Allows to manage buttons collection on the toolbars and toolbars collection of the CommandBarManager. The “Toolbars” checklist box displays toolbars available in the application. The item in the Listbox will be checked if the toolbar is visible.  The “New” button allows to create a new custom toolbar. The “Reset” button resets the selected in the “Toolbars” list toolbar to it’s original state and “Reset All” removes any changed in all available toolbars. Button “Delete” allows to delete and button “Rename” allows to rename the custom toolbar choosed in the Toolbar list.

Keyboard:
Allows to assign shortcuts for commands from current command manager.
Using “Category” combobox we can display a set of the commands based on the selected category in the command list.  After selecting any commands in the Command list in the “Current Keys” list available shortcut key combination for this command will be displayed. For the selected command we can assign new shortcut, remove one of the displayed shortcut or restore the initial by clicking on “Reset All” button.

Option:

Allows to assign some sets for the toolbar. Option “Show Screen Tips on toolbars” specifies if the tooltips will be shown for CommandBars of the current CommandManager. If the user wants to display shortcut keys combinations on the tooltips he has to check an option “Show shortcut keys in Screen Tips”.  Option “Large Icons” allows to increase the size of the toolbar  icons.

ClassCustomizeManager The instance of the CommandBar Manager is created on the initialization of the CommandBarManager. Its property IsCustomizeMode allows to set a customize mode for the CommandBarManager  and on its changing the event OnCustomizeModeChanged is raised.
ClassCustomizeMenuBar Inherits PalettePopupMenuBar of the BCGSoft.ControlBars namespace. Used to show popup menu for customize button. Has an equal  procedure of adjusting the layout of the button on it.
ClassDockBar

Implements ISerializable interface.

Inherits Control of namespace Windows.Forms. Implements such interfaces as BCGSoft.Shared.ISupportCustomLayout, ISerializable.
Manages docked command bars.
DockBar objects are automatically created by the framework when you specify CommandBarManager property.

A
DockBar object manages a list of DockBarRow objects. When a command bar is docked to one of the edges of the host form, an appropriate DockBar control becomes the immediate Parent of the docked command bar. All docked command bars are placed on logical rows represented by the DockBarRow type. 

 

ClassDockBarCollection

Inherits ArrayList class of System.Collection namespace.
Represents a collection of the dock bar objects owned by the CommandBarManager.
CommandBarManager has a property DockBarCollection in which we can get any DockBar from this collection by it’s index.
New DockBarsCollection is created on initialization of the CommandBarManager and CommandBarManager manages its dockbar using this collection.

ClassDockBarRow

 Implements ISerializable interface. Logical representation of a row (vertical or horizontal) containing a list of the docked command bars.
DockBarRow objects are automatically added and removed to/from parent DockBar control while command bars are docked, floated or dragged. The DockBarRow class represents a logical entity. It manages a list of control bars that are docked at the parent dock bar and are located in the same horizontal or vertical row.

Usually, you don't have to work with these objects directly.

ClassDockBarRowHeightChangedEventArgs

Inherits EventArgs Class of namespace System.
Provides data for the DockBarRowHeightChanged event.
Data contains such properties as the Height of the DockBarRow before changing (Property OldHeight) and after it. (Property NewHeight).

ClassDockBarRowVisibleChangedEventArgs

Inherits EventArgs Class of namespace System.
Provides data for the DockBarRowVisibleChanged event.
 Data contains the property PrevVisibleState, which specifies the visibility of the DockBarRow before the DockBarRowVisible event occurs.

ClassDockEventArgs Provides information for several events raised by DockManager when DockingPane's dock state has changed.
ClassDockInfo

Contains a set of settings related to the dock style of the docking pane. This structure has overloaded operator = and copy. Has a property ClientRectDock specifies the client rectangle of the docking bar. The sets of the settings contains such data as the docking rectangle, target docking pane to be docked, docking style, SDMarker used for tracking the docking pane, some Boolean properties specifies if the target docking pane should be docked, if it should be docked as a tab or if it should be docked by outer edge. In ControlBar.Net it is used in DockManager, TabbedGroup, Tracker, DockingPane, MiniFrame classes to get information about docking of any docking pane.

ClassDockingContainer

Implements ISerializable, IResizeTarget interfaces.
Each
 DockingContainer object maintains a list of docking panes and sliders. Each object has a default slider used to resize the whole container. Docking panes are organized as a nested table. In each cell resides a docking object which can be either control wrapper or another dock table. Internal (non-default) sliders serve as bounds for the table cells and, actually, split docking panes.

ClassDockingPane

Inherits ContainerControl from the namespace System.Windows.Form. Implements such interfaces as ISupportCustomLayout, IRecentRectProvider, ISerializable, IActiveContainer, IPendingVisibleState, IServiceProvider, IMessageFilter.

Provides a functionality of docking control. DockingPane control  can be docked to one of the edges of the form or float as a miniframe. Its client field can be filled by another control.

Some DockingPane controls can be join to the tabbed group. When we place one control to another new DockingPane will be dynamically created in runtime and  new TabControl will be created. You can place on it other DockingPane controls.

For creating DockingPane control and TabControl dynamically in runtime we have to use DockManager.

ClassDockManager

Inherits Component class of Windows.System.ComponentModel.  

Manages all floating and docked docking panes.
You should add this component to each Form you want to enable dockable and floating command bars for.

You can add any docking panes to be managed by DockManager using AddDockingPane method.

By changing DockingType property we can specify the look and feel of the docking markers during the tracking of the docking panes.

The property AutoHideEdges allows  you to specify what sides can be used by docking panes as autohide edges.

You can make any docking pane dockable with specified characteristic using methods DockControl and undock it by the method UndockPane, make it floating  using method FloatDockingPane, FloatDockingPaneOnRecentFrame.

DockManager can save and load state using LoadState and SaveState methods.

ClassDockTable  
ClassDropDownListBox  
ClassEntry  
ClassFrameCaptionButton Specifies a button located on the caption of the Form in MS Office 2007-style UI. The standard set of buttons contains "Close", "Minimize", "Maximize" (or "Restore") buttons.
ClassGalleryCommandObject Implements an object
ClassGalleryControl

The Gallery control implements Microsoft Ofiice 2007-style gallery. A gallery is organized as a set of groups, where each group may have its own caption and each group item may have an image and text.

Currently the Gallery control works in three modes: Compact, Full and Menu.

In the Compact mode the Gallery is represented as a set of images layed out as a palette. There are two scroll buttons and one button, which opens the Gallery in the Full mode,  at the right side of the palette. Group captions are not displayed in this mode.

In the Full mode the Gallery looks like a popup menu, where a group caption takes the full width of the control and next to the caption goes a palette with group items. Each item is represented by its image (texts are not used in thos mode). A Gallery may contain several groups.

The Menu mode is a special type of the Full mode. You must set the IsMenuMode property to true in order to enable menu mode. In the Menu mode the gallery still displays group captions, but all items are layed out like the regular popup menu items. You can set up the menu to draw manu margin, show checked and pressed states, specify item margins (which affect the height of gallery items) and so on. 

You need to initialize the GalleryGroupItems collection with GalleryGroup objects to make the Gallery to display groups.

When the Gallery control has been initialized, it buids an internal flat list of items of the GalleryCommandObject type. Group captions are also treated as items, so if you need to find out an index of a specific item, you need to take into account the caption items.  

ClassGalleryFontCommandObject Represents a command object hosted by gallery used in SmartFontComboBoxButton.
ClassGalleryGroup Represents a gallery group. A gallery group has a group name, collection of item images and collection of item texts. Both collections may have different size, or one of collections can be empty. The number of gallery items instantiated from the group equals to the largest collection.
ClassGalleryHighlightChangedEventArgs Provides data for the GalleryHighlightChaged event.
ClassGalleryScrollButton  
ClassGlassTextBox  
ClassImageEditor

Inherits a Form class of System.Windows.Forms namespace.

Represents a dialog box called on customization to edit toolbar button image. In ControlBar.NET the instance of the ImageEditor is created in the ProcessCustomizeMenuCommand method of the Toolbar class.  The ImageEditor is shown when the toolbar is on the customize mode and the user clicks on its button (except ColorButton). By ImageEditor you can copy the content of the ImageEditorArea to the clipboard, paste  the image from another button, fill ImageEditorArea by different colors, draw pixels, lines, ellipses, rectangles with different colors.
ClassImageEditorArea

Inherits Control class of System.Windows.Forms namespace.
Represents a control on the ImageEditor where an image to edit is displayed.

ClassLayoutController

Manages the layout and state  of the objects from DockManager, CommandbarManager, MDITabsOption.

 The method EnableMDITabs allows to place MDIChild form in the TabControl and to adjust theirs layout.

The AdjustLayout allows to place in order the size and location of docking panes and control bars on the form.
The methods SaveState and LoadState allows to  save and load state of controls to/from a stream.
The methods RegisterComponent and UnRegisterComponent are used for definition of the parent form for MDITabsOption, CommandManager and DockManager on setting ParentForm.
LayoutController class has a set of event handlers for  such events  as ResizeForm, ControlAddedToForm, ControlRemovedToForm, FormLayout, FormDisposed.
Methods GetCommandBarManager, GetDockManager, GetMdiClient, GetMdiTabsOptions allows to get an access to managers of the specified  form.

ClassLayoutController.PreAlignContainer  
ClassMDIClientArea

Inherits Panel Class of System.Windows.Forms.

Represents the area  where MDIContainers for multiple-document interface (MDI) child forms are located.  The instance of this object will be created only if child forms are tabbed documents.

The instance of MDIClientArea is created when we set the parameter value of  EnableMDITabs method in class LayoutController  equal true. The access to the instance of the current MDIClientArea you can get by means of methods GetMdiClient of LayoutController.

The properties of MDIClientArea class allow to get an access to current active MDI container, active docking pane, active MDI form, active Tab Item.  Property TabAlignment specifies the location of tab control in MDIContainers of this MDIClientArea. Method AddMDIContainer   allows to add an MDIContainer to MDIContainerCollection belongs to this MDIClientArea. Also methods FindTabItemByControl and FindTabItemByName allows to find specified TabItem.
ClassMdiClientListener  
ClassMDIContainer

Inherits Control class of the System.Windows.Forms namespace.

Represents the container for multiple-document interface (MDI) child forms.  The instance of this object will be created only if child forms are tabbed documents. The instance of MDIContainer  will be created by default on creation MDIClientArea. Another MDIContainers we can add by method AddMdiContainer   of MDIClientArea class. The access to the MDIContainer collection of the MDIClientArea you can get using property MDIContainers of the MDIClientArea.

MDIContainer class is used for managing MDI forms and their tabstrip.
Properties of MDIContainer class allow to get an access to the TabstripControl, it’s TabItemCollection, MDITabsOption object related to MDIContainer, get current active MDI form. Method FindTabItemByName allows to find a tabbed document with the text specified in parameter “value”. Methods CloseAllBut, CloseTab make tab documents invisible. On the event TabStripMouseUp the context menu for current tabstrip will be shown. The MDIContainer class has as eventhandlers for the commands of this context menu as eventhandlers for events raised on the tab control, on changing visual manager and others.

ClassMDIContainerCollection

Inherits from CollectionWithEvents class.
Represents a collection of the MDIContainers. You can get an access to this collection by the property MDIContainers  of the MDIClientArea.

ClassMdiTabCloseEventArgs  
ClassMdiTabsContextMenuEventArgs
Inherits EventArgs Class of namespace System.
Provides data for the MdiTabsContextMenu event.
ClassMdiTabsOptions Inherits Component of System.ComponentModel namespace.
Manages tabbed MDIChild forms. The instance of the MdiTabsOptions can be added from the group BCGControlBar of the Toolbox. Using this object you can specify such setting of the tabstrip as TabAlignment, TabLayout, TabStyle, TextMargin. You can define if CloseButton and ScrollButtons will be visible on the tabstrip.
ClassMdiTabsOptionsDesigner  
ClassMenuBar

This object represents a main menu bar. It inherits from the toolbar class. A menu bar is a special type of toolbar. It represents a menu bar for application. If menu bar is associated with a MDI container, it tracks state of MDI child windows and displays additional minimize, restore and close buttons. A menu bar can behave as a regular toolbar, but it's property ExclusiveRow is true by default. The MenuBar object is serializable. We can load from the xml-file it’s state, button collection, layout, Visual Style.

The MenuBar class encapsulates the functionality of Windows menu and docking toolbar. It provides member functions for creating from the standard Windows menu,  layout calculation, tracking dynamic changes in the default menu,  loading and saving it's state.
ClassMiniFrame Inherits Form class of System.Windows.Forms namespace. Implements interface ISerializable. Represents a popup window that hosts a docking pane in floating state.  A MiniFrame is created  automatically when the docking pane becomes floating (see FloatDockingPane method of the DockManager class).  All miniframes of  the current DockManager are located in its collection of floating frames.
ClassMoreColorsMenuButton  
ClassNativeWindowForm  
ClassPalettePopupMenuBar

Inherits PopupMenuBar.  Represents a popup menu bar on which we can add a control (or an array of controls). In ControlBar.Net library it is used for creating popup menu for color button and a container for dropdown list in the toolbar combobox button.

ClassPersistStateEventArgs  
ClassPopupFrame Inherits Panel class from the System.Windows.Forms namespace, implements ISupportCustomLayout interface. It represents a base class for the PopupMenu. It assigns the location of the popup menu and manages events on adding and removing control on it.
ClassPopupMenu Inherits PopupFrame of  BCGSoft.ControlsBar namespace.  Represents the control on which the popup menu bar is located. This control is used in ContextMenuManager class, Toolbar  class, classes related to toolbar buttons, classes which has popup menu for different commands.
 In this class the appearance and the shadow for the popupmenu are painted.
ClassPopupMenuBar

 Inherits Toolbar of the BCGSoft.ControlBar namespace. Implements interface IMessageFilter.

Represents the toolbar for popup menu, which contains popup menu buttons. It will be placed on the popup menu control.

ClassPopupMenuItemClickEventArgs

Provides data for the ItemClick event of the PopupMenuBar. This event is rased on MouseUp event in the PopupMenuBar.

ClassQuickCustomizeButton

Inherited from  ToolbarMenuButton, implements ISerializable interface. It is used to show “Add or remove button” button on the popup menu of the customize button. This class is used for calculation of the size and layout  of this button , defining it’s visual state and protection of setting Large icon mode. The popup menu of the Quick customize button allows  to manage the visibility of the toolbar buttons, call  the Customize dialog box, restores the Toolbox to the state it was in when the application was first launched.

ClassRelatedBarSetEventArgs
Inherits EventArgs Class of namespace System.

Provides data for the RelatedBarSet event of the CommandBarManager. Property CommandBar returns Commandbar of type BCGSoft.ControlsBar.CommandBar  and the property RelatedForm returns Form of type System.Windows.Form which  CommandBar will be related to.

ClassSDManager Manages smart docking marker on tracking docking pane.  SDManager class contains some static members which allow to create a new instance of SDManager, get the size and transparency of the SDMarkers, current DockStyle. In SDManager images for smart markers are set.  
ClassSDMarker

Inherits SimplePopup Class of the BCGSoft.Controls.Shared.

Represents smart docking marker. Such docking markers are used in Visual Studio 2005 on tracking docking panes. The SDMarkers are managed by an instance of the SDManager.
ClassSDPlaceMarkerForm

Inherits SimplePopup Class of the BCGSoft.Controls.Shared.

Represents a container where smart docking markers are located.

ClassShadowFrame  
ClassShowAllButton

Inherits ToolbarMenuButton Class of the BCGSoft.ControlBars namespace.

Represents a button on the popup menu bar which lets to make all buttons visible on the popupmenu bar include rarely used.  The instance of ShowAllButtons is created in PopupMenuBar class and managed by it.

ClassShowPopupMenuEventArgs

Inherits System.ComponentModel.CancelEventArgs.

Provides data for the BeforeShowPopupMenu,  AfterShowPopupMenu cancelable  events of the CommandBarManager. The property PopupBar represents an instance of PopupMenuBar to show and the ParentButton property specifies the host ToolbarMenuButton of this PopupMenuBar.

ClassSmartComboBoxButton Represents a combo box button whose drop down part is a popup Gallery control.
ClassSmartEditBoxButton Represent an edit box control, which can be placed on a smart command bar (Ribbon Control) and whose distance between text and edit box part is adjusted automatically, depending on layout of other controls in the same column.
ClassSmartFontComboBoxButton Implements smart (gallery-based) combo box, which is automatically filled by font names from the InstalledFontCollection collection. You can use this button as any other gallery button.
ClassSmartProgressBarButton SmartProgressBarButton contains a progress bar control which  is  used  to indicate the progress of a lengthy operation. It contains a rectangle that is gradually filled with the system highlight color as an operation progresses. It can be placed on the Ribbon control and the progress can be triggered by an event .
Progress bar can operate in two modes – regular and infinite. In the regular mode the progress is filled from left to right and stops when reaches the maximum value. In infinite mode the progress is filled from minimum value to maximum value and back.
ClassSmartTrackBarButton The SmartTrackBarButton contains an embedded TrackBar control and is used for navigating for visually adjusting a numeric setting. The  embedded  TrackBar control has some parts: the thumb, also known as a slider, the tick mark and zoom buttons. The thumb is the part that can be adjusted. Its position corresponds to the Value property. The tick mark is visual indicators that is located in the center of the TrackBar control.
When we drag a thumb or click on Zoom buttons the value of the TrackBar will be changed on the value of the property SmallChange, if we click on the channel the value of the TrackBar will be changed on the value of the property LargeChange.
When the value of the SmartTrackBarButton is changed, the ValueChanged event will be raise.
ClassSmartUndoButton The SmartUndoButton can be added to a Category item on the Ribbon or to an ItemsGroup.
It  implements the functionality of a menu button with popup menu. It is possible to select a couple of actions from this list and execute ("undo" or "redo") all of them. If the button itself is clicked, then only one (last added) action should be executed. In fact, the button acts as LIFO stack.
When we select any item from the popup menu, the action located after selected item will be removed from the LIFO Stack.
The SmartUndoButton can be of two types. If the value of the property CustomUndoButton is set to true, names of actions will be displayed in popup menu, other wise the number of action to be undone will be show as a text on every button. The size of the SmartUndoButton stack is non fixed.  Its size depends on the number of action to undo (or redo).
ClassSmartUndoLabel  
ClassSmartUndoMenuButton  
ClassSplitterControl

Inherits Control Class of System.Windows.Forms namespace. Implements interface BCGSoft.Shared.ISupportCustomLayout, System.Runtime.Serialization.Runtime.
Represents a control that divides a docking container's display area  into two resizable docking panes.

ClassSplitterControlMovedEventArgs

Inherits EventArgs Class of namespace System.
Provides data for the SplitterControlMoved  events of the AutoHideButton and DockingContainer, DefaultSplitterMoved of DockingContainer,  SplitterMoved event of the splitter control.  Property Value  specifies the offset of the splitter made on moving it.

ClassSplitterHolder Represents a container for splitter control. In SpillerHolder class specified such parameters as visibility, location, bounds, size, parent control,  parent dock table.
ClassStatusBarControl

Inherits ContainerControl class of System.Windows.Forms. Implements the functionality of status bar.
In addition to standard features you can add animation, progress bar and subscribe to the StatusBarPaneDoubleClick event that is raised when user double clicks on a status bar pane.
If you create a pane with OwnerDraw style, then status bar raises the DrawItem event when it is about to be redrawn.
Use SetMessageString method in order to define a default text to be drawn on the default panel. This text is always displayed on the default message panel when there is no other text to display (such as message strings for toolbar buttons).
A status bar may have only one default message panel. The Panels property represents the list of status bar panels (panes). Because this collection can raise events, you can modify this collection and properties of its items directly.

ClassStatusBarPaneCollection Inherits from CollectionWithEvents class. Represents a collection of the statusbar  panes of the status bar control. You can get this collection for the specified status bar using its property StatusBarPaneCollection. The collection of the status bar panes is created on the initialization of the statusbar.
ClassStatusBarPaneEventArgs
Inherits EventArgs Class of namespace System.
Provides data for the PaneDoubleClick  events of the StatusBarControl. Property Panel represents an item of the StatusBarPaneInfo class to be double clicked.
ClassStatusBarPaneInfo

Implements Component class of the System.ComponentModel namespace. Implements interface INotifyPropertyChanged.  Represents an individual panel in the StatusBarPaneCollection of the StatusBar control. A StatusBarPanel can contain text and/or an icon that can be used to reflect the status of the application. You can add animation, progress bar, images to the statusbar pane.

ClassTabbedGroup

Inherits TabControlEx class of BCGSoft.Controls.TabStrip namespace. Implements interface ISerializable. Manages a related set of tab docking panes. Created by the method CloneTabbedWindow of the DockingPane class, when a user docks as tabbed control one docking pane to another and the last docking pane has not been in tabbed group yet.

ClassTabInfo Implements interface ISerializable. Represents an information about tabs within the tabbed group. It contains such information as visibility of the tab, backcolor, textcolor, width, image, detachability, disability. The collection of the TabInfo items of the one tab group  is located in the class TabInfoArray.
ClassToolbar

Inherits CommandBar class of the BCGSoft.ControlBars namespace. Implements interface IMessageFilter of the System.Windows.Forms namespace  and ISerializable of System.Runtime.Serialization namespace.

A command bar-derived object that represents a toolbar. A toolbar contains a set of toolbar buttons associated with commands. When a toolbar button is pressed, it fires the ToolbarButtonClick event. If a button can show tooltip, a toolbar fires the ToolbarButtonShowTooltip event when the mouse hovers over the button.
ClassToolbarBaseControlButton Inherits ToolbarMenuButton, implements interface ISerializable. Serves as a base class for a ToolbarFocusableButton, ToolbarTrackButton and ToolbarButtonGroup. Contains some method to specify the current size, location and appearance of the ToolbarBaseControlButton.
ClassToolbarBaseGalleryButton Implements basic behavior for gallery-based buttons (ToolbarGalleryButton, SmartComboBoxButton).
ClassToolbarButton

Inherits BCGSoft.Controls.Shared.CommandButton. Supports  such interfaces as ISupportCmdUI, IDataObject, ICloneable, ISerializable.

ToolbarButton objects are non-Windows controls that reside on toolbars. Their behavior is similar to the regular buttons and they can be assigned an image and a text label. In addition, a toolbar button can have a command ID. This command is executed when the user clicks the button.

The ToolbarButton class can serve as a base class for more complicated toolbar button objects, like "menu button", "edit box button" or "combo box button".  Toolbar buttons are usually placed on the toolbars. When a toolbar button is clicked, it's host toolbar fires the ToolbarButtonClick event.

Usually, toolbar buttons can be customized, the user is able to drag them from one toolbar to another, copy, paste, delete, edit text labels and images.

ClassToolbarButtonClickEventArgs

Inherits EventArgs Class of namespace System.

Provides data for the ToolbarButtonClick event of the ToolBar. 
The property Button returns a clicked ToolbarButton.
ClassToolbarButtonCollection Inherits CollectionWithEvents  of the BCGSoft::Shared namespace.
Represents the collection of the toolbar button on the toolbar or on the menu button.
ClassToolbarButtonGroup Represents a control that can contain a set of related buttons on it. CategoryItems from the Ribbon Control contain ToolbarButtonGroup to arrange buttons.
ClassToolBarButtonParentChagingEventArgs Inherits EventArgs of the namespace System.
Provides data for ParentCommandBarChanging event of the ToolbarButton. The property NewCommand specifies the toolbar on which the ToolbarButton will be placed. Property AllowChange specifies if the change on the target toolbar are allowed. The default value of this property is true.
ClassToolbarButtonShowTooltipEventArgs Inherits EventArgs of the namespace System.
Provides data for  ToolbarButtonShowTooltip event of the Toolbar. Property Button specifies the toolbarbutton to set a tooltip and property TipText    -  the text of the tooltip.
ClassToolBarButtonWidthChangingEventArgs Provides data for ToolBarButtonWidthChanging event. This event is raised when the new width for the ToolBarButton width is set.
ClassToolbarCheckBoxButton Represents a ToolbarButton which contains a check box control it it.
ClassToolbarComboBoxButton

Inherits ToolbarFocusableButton of the BCGSoft.Controlbar namespace. Implements interface ISerializable. Implements a  button with a combo box that can be placed on toolbar.

ClassToolbarDateTimeControl The ToolbarDateTimeControl class is used to display time, typically expressed in date and time.  It encapsulates the functionality of the date and time picker control. It can be placed to toolbar and Ribbon controls. The interface of the ToolbarDateTimeControl contains fields for displaying a part of the date and time information stored in the control. The user can change the selected date and time by changing the content of the text in the specified field of the control. The user can select fields of control using mouse or keyboard. The content of any field can be changed by typing text or by pressing Up and Down key on the keyboard.  The date value can be changed by the drop down calendar.
The input can be enabled\disabled by checkbox located within the DateTimeControl. The sets of fields on the DateTimeControl can be  customized by changing it’s specified properties in the property list.
ClassToolbarEditBoxButton Inherits ToolbarFocusableButton of the BCGSoft.Controlbar namespace. Implements interface ISerializable. ToolbarEditBoxButton implements a text box that can be placed on a toolbar. The embedded text box control can be accessed via EmbeddedTextBox property.
ClassToolbarFocusableButton Inherits ToolbarMenuButton. Implements interfaces IMessageFilter, ISerializable.
Represents a button which can get a focus. It is a base class for toolbar button with controls (Toolbar ComboBox and Toolbar EditBox).
ClassToolbarGalleryButton Represents an instance of ToolbarButton located on the RibbonControl and has a GalleryButton as internal control.
ClassToolbarLabelButton Represents a toolbar button, which can be has a label functionality. It can not be highlighted or clicked. It is typically used to provide descirptive text within the toolbar. For example, you can use ToolbarLabelButton to inform user about the name of the button's group.
ClassToolbarLinkLabel Implements a button which represents a link to URL.
ClassToolbarMenuButton

Inherits ToolbarButton, implement interface ISerializable.
Represents a button which can be placed on menu bar or popup menu bar and contains a list of sub-menu commands.
ToolbarMenuButton behaves exactly as a toolbar button, but in addition it may have a list of sub-menu commands and be a parent button of a popup menu. ShowPopupMenu displays a popup menu if this list is not empty.

ClassToolbarNameDialog Represents a dialog box, that can be used to assign the name of the Toolbar on customization.
ClassToolbarPaletteButton Inherits ToolbarButton class of BCGSoft.ControlBars namespace. The ToolbarPaletteButton  behaves exactly as a toolbar button, but on click an instance of the PalettePopupMenu bar can be shown. The PalettePopupMenuButton can be the host of toolbar buttons or other command objects.
ClassToolbarProgressBarButton This button is designed for Ribbon Status Bar. In general, it can be placed as any other button on a toolbar or menu, but this is not recommended.
ClassToolbarSpinButton Implements a button with spin control. Spin arrows allow to increment or decrement the value.
ClassToolbarSysMenuButton Inherits ToolbarButton.
Represents a menu-bar buttons, for example, the child window Minimize button used in the multiple document interface. In ControlBar.Net the instances of this buttons are created on the main menu of the MDIContainer when  the Maximize mode will be set for Active MDI Form. The toolbarSysMenuButton is drawn by the method OnDraw and its size is defined in method OnCalculateSize as the static property MenuButtonSize of SystemInformation.
ClassToolbarTrackBarButton Represents a Toolbar Button which contains a Track bar control in it.
ClassTracker Tracker control is used for navigation docking pane over the form. In this class  the layout as of the tracking control as of the tick marks during its navigation is defined.  The tracker is created on the method InitTracker of the DockManager. This event is raised when the event OnMouseMove of the Docking pane occurs and the DockingPane has a mouse capture. In MiniFrame the tracker will be created by the left mouse click on it.  In TabbedGroup  on the event TrackTabItem the tracker will be created   when we begin to move a tab item.
The tracker is deleted on the method EndTrack of the dockmanager.
ClassUpdateCmdUIEventArgs Inherits EventArgs of the namespace System.
Provides data for UpdateCmdUI event of the CommandBarManager. Property CommandID specifies the identifier of the command to update event arguments. Property Enable indicates whether the control can respond to user interaction. Property Check specifies if the command is checked. Property Updated gets true if the command was updated.
ClassWrongStateException  
Interfaces
 InterfaceDescription
InterfaceIRecentRectProvider

Used to get recent rectangle on tracking.

InterfaceIResizeTarget  
Delegates
 DelegateDescription
DelegateBeforeAddFontEventHandler  
DelegateCloseDockingPaneEventHandler  
DelegateCurrentColorChangedHandler  
DelegateDockBarRowHeightChangedEventHandler

Represents the method that will handle RowHeightChanged event of the DockBar.
This event is raised when a new height of the dockbar row will be set in property Height of the DockBarRow class.
In ControlBar .NET library this event is used for raising another event related to resizing and rearranging dockbarrows of the current Dockbar.

DelegateDockBarRowVisibleChangedEventHandler

Represents the method that will handle Visible Changes event of the DockBarRow and ShowRow of the DockBar.

DelegateDockEventHandler Represents the method that will handle events raised by DockManager when a DockingPane's state has changed.
DelegateGalleryHighlightChangedEventHandler Represents the method that will handle GalleryHighlightChanged event of ToolbarBaseGalleryButton.
DelegateMdiTabCloseEventHandler  
DelegateMdiTabsContextMenuHandler
Represents the method that will handle MdiTabsContextMenu event of a MdiTabsOptions. 
The event related to event handler raised in OnTabStripMouseUp method of the MDITabsOption class.
DelegateParentCommandBarChangingHandler
Represents the method that will handle ParentCommandBarChanging event of a ToolbarButton. 
This events are raised when the toolbar button changes the parent command bar.
DelegatePersistStateEventHandler  
DelegatePopupMenuItemClickEventHandler
Represents the method that will handle PopupMenuItemClick event of a PopupMenuBar. 
This event is raised on MouseUp event of the PopupMenuBar.
DelegateRelatedBarSetHandler

Represents the method that will handle RelatedBarSet event of the CommandBarManager. 
The event RelatedBarSet relates a Commandbar and it’s parent form.
DelegateShowPopupMenuHandler Represents the method that will handle BeforeShowPopupMenu,  AfterShowPopupMenu cancelable  events of a CommandBarManager.
DelegateSplitterControlMovedEventHandler Represents the method that will handle SplitterMoved  events of  the splitter control. The  SplitterMoved event is raised on the SplitterControl class on MouseUp event.
DelegateStatusBarDrawItemHandler

Represents the method that will handle PaneDrawItem  events of the StatusBarControl. The DrawItem method is raised in the method OnDrawPane of  the status bar class if the status bar pane has owner draw style.

DelegateStatusBarPaneDoubleClickHandler

Represents the method that will handle PaneDoubleClick  events of a StatusBarControl. The event is raised when a user makes double click on the status bar pane.

DelegateToolbarButtonClickHandler Represents the method that will handle ToolbarButtonClick event of the ToolBar.  The event ToolbarButtonClick is raised when any toolbar button on the toolbar is clicked.
DelegateToolbarButtonShowTooltipHandler Represents the method that will handle ToolbarButtonShowTooltip event of the Toolbar. The event ToolbarButtonShowTooltip is raised on the ProcessMouseMove event of the Toolbar when the length of the tooltip text more than 0.
DelegateUpdateCmdUIHandler Represents the method that will handle UpdateCmdUI event of the CommandBarManager. This event  forces a refresh of the command UI state.
DelegateWidthChangingHandler Represents the method that will handle WidthChanging event of the ToolbarButton. This event is raised when the new value of the property Width of the ToolbarButton is set.
Enumerations
 EnumerationDescription
EnumerationDockingPaneState Specifies the current state  of the docking pane.  The variable of this type is returned in DockingPane class in the property PaneState and  the method GetRestoredPaneState.

EnumerationDockingStyle Specifies the runtime indicators of the docking pane.
EnumerationDropState

The DropState enumeration is a list of constant values that specify the various different types of dropping toobar button on customization.

EnumerationHDPIImageMode  
EnumerationImageEditMode

Specifies tools for editing image in image editor.

EnumerationMdiTabsMode  
EnumerationMenuResizeType Specifies how the popup menu can be resized.
EnumerationMONTH_FORMAT Defines how the Month value is displayed in the ToolbarDateTimeControl button.
EnumerationOverlapAutoHideButtonsType

Specifies if autohide buttons will overlap each other on the AutoHidePanel. The property OverlapAutoHideButtons of the DockManager has the type defined on this enumeration. This property is used in the method AdjustLayout of the class AutoHideButtons for specification of the layout of buttons. The default value of the property OverlappedAutoHideButtons is Default.

EnumerationPART_TYPE Defines part types of ToolbarDateTimeControl. Use this enumerator to access different parts of date time control (such as days, hours, minutes etc).
EnumerationSDMarkerState Specifies the current state of the smart docking marker . According this state in the instance of the SDManager class  in method GetImage the image for the marker will be returned. The property MarkerState of the class SDMarker allows to get or set definite SDMarkerState for the Marker.  On initialization marker gets the normal state. During tracking marker state can be changed to highlighted or disabled.
EnumerationSDMarkerType

Specifies the current type of the smart docking marker. In SDManager the variable of this type defines the images and location of the Smart docking marker.  The property SDMarkerTypeToDockStyle of SDManager class returns the DockStyle for the docking pane in relation of Marker Type. In method TrackSmart of class Tracker this DockStyle specifies the docking edge of the tracked control.

EnumerationToolbarButtonCollapseState

Specifies collapse state for the command object (ttolbar button) placed on the smart command bar (Ribbon control).

Some buttons may interprete this state on their own. For example, the smart combo box button in the Large state displays combo box, image and text, in Intermediate state it displas image and combo box, in Small state - combo box only.

 

See Also

Reference

BCGSoft.ControlBars Assembly

Send Feedback