TabToolBar Collection Members
See Also
- TabToolBar Overview
- TabControlItem Object
- Category Property
- InsertCategory Method
- RedrawBar Method
- UpdateTabs Method
- AllowReorder Property
- CategoryCount Property
- XTPTabLayoutStyle Enumeration
- TabPaintManager Property
- RecalcLayout Method
- MinimumWidth Property
- RemoveCategory Method
- AddTabToolBar Method
TabToolBar Collection Members
Public Methods
| Method | Description |
|---|---|
 Delete |
Deletes the Tabbed Toolbar. |
| EnableDocking |
Enables docking of the Tabbed Toolbar to different edges of the form or it can be "floating". |
| FindControl |
Finds and returns the specified control within the Tabbed ToolBar's collection of controls. |
| GetIconHeight |
Gets the height of the icons displayed in the Tabbed Toolbar. |
| GetIconWidth |
Gets the width of the icons displayed in the Tabbed Toolbar. |
| GetWindowRect |
Gets the bounding rectangle of the Tabbed Toolbar. This is the area of the window that the Tabbed ToolBar occupies. |
| InsertCategory |
Inserts a category into the Tabbed Toolbar. |
| ModifyStyle |
Modifies the style of the Tabbed ToolBar. This allows you to add/remove the "gripper". |
| RecalcLayout |
Call this method to re-calculate the layout of the Tabbed ToolBar after making a layout change. |
| RedrawBar |
Call this method to redraw the Tabbed Toolbar after making a change that requires the Tabbed Toolbar to be re-painted. |
| RemoveCategory |
Removes a category from the Tabbed ToolBar. |
| Reset |
Resets the controls in the Tabbed ToolBar to their original state. |
| SetFlags |
Sets the flags of the Tabbed ToolBar. This allows you to add/remove the MDI buttons that are displayed in the toolbar. |
| SetIconSize |
Sets the size of the icons displayed in the Tabbed ToolBar. |
| UpdateTabs |
Updates all the categories in the Tabbed Toolbar with any buttons/controls that have been added. Controls will not become visible in the tabs/categories until this method is called. |
Public Properties
| Property | Description |
|---|---|
 AllowReorder |
Enables/Disables tab reordering within the Tabbed Toolbar. |
| BarID |
Gets the ID of the Tabbed ToolBar. |
| BuiltIn |
Gets whether the Tabbed Toolbar is a built-in command bar or a command bar added by the user using the customize dialog. |
| Category |
Collection of tabs (TabControlItem objects) that correspond to all the categories that have been added to the Tabbed ToolBar. |
| CategoryCount |
Total number of categories that have been inserted into the Tabbed ToolBar. |
| Closeable |
Gets/Sets a Boolean value indicating whether the Tabbed ToolBar is closeable. If false, the Tabbed ToolBar cannot be closed or hidden. |
| CommandBars |
Reference to the parent CommandBars object. |
| ContextMenuPresent |
Gets/Sets whether a command to hide/show the tabbed toolbar is added to the context menu that is displayed when you right-click on any command bar, dialog bar, or tabbed toolbar. |
| Controls |
Gets the collection of controls in the Tabbed ToolBar. |
| Customizable |
Gets/Sets a Boolean value indicating whether the Tabbed ToolBar is customizable. |
| CustomizeDialogPresent |
Gets/Sets whether the tabbed toolbar appears in the Customization Dialog. |
| DefaultButtonStyle |
Specifies the default style that will be applied to controls added to the toolbar. |
| DoubleGripper |
Specifies whether menu items that are "checked" will have both a check mark and an image next to them in the popup menu. |
| EnableAnimation |
Specifies whether to use animation effects with this tabbed toolbar. |
| hWnd |
Returns the handle of the Tabbed Toolbar. |
| MinimumWidth |
Gets/Sets the minimum width of the Tabbed Toolbar. |
| Position |
Gets/Sets the position of the tabbed toolbar. |
| SelectedControl |
Gets the currently selected control from the tabbed toolbar. |
| ShowExpandButton |
Shows or hides the Expand Button for the tabbed toolbar. |
| ShowGripper |
Hides/Shows the toolbar gripper. |
| ShowTextBelowIcons |
Shows the caption of controls added to the toolbar below the control's icon. |
| TabPaintManager |
Gets the paint manager properties used to draw the tabs in the Tabbed Toolbar. |
| Title |
Gets/Sets the title of the tabbed toolbar. |
| Type |
Gets the type of the command bar. |
| Visible |
Gets/Sets a boolean value indicating whether the tabbed toolbar is visible. |
| Width |
Gets/Sets the width of the toolbar in pixels when it is floating or displayed as a popup. |
Events
| Event | Description |
|---|---|
 BeforeItemClick |
Occurs when a tab button is clicked, but before the click message is processed by the CommandBars. |
| SelectedChanged |
Occurs when a new TabControlItem is selected in the TabToolBar. I.e., the focus has changed from one tab to another. |
See Also
- TabToolBar Overview
- TabControlItem Object
- Category Property
- InsertCategory Method
- RedrawBar Method
- UpdateTabs Method
- AllowReorder Property
- CategoryCount Property
- XTPTabLayoutStyle Enumeration
- TabPaintManager Property
- RecalcLayout Method
- MinimumWidth Property
- RemoveCategory Method
- AddTabToolBar Method
Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.