TdxRibbonCustomToolbar Class
The base class for docked Ribbon toolbar containers.
Declaration
TdxRibbonCustomToolbar = class(
TInterfacedPersistent,
IdxRibbonToolbarContainer
)Remarks
TdxRibbonCustomToolbar is the base class for all types of docked Ribbon toolbar containers the TdxRibbon control can display. Docked Ribbon toolbar containers allow users to access important functionality directly, without the need to navigate through Ribbon tabs or tab groups.
Tip
To display a toolbar (a TdxBar instance) and its content in a docked Ribbon toolbar container, assign the toolbar to the Toolbar property.
Different docked toolbar containers have dedicated positions in the Ribbon UI. Refer to individual docked toolbar type descriptions for details.
Docked Ribbon Toolbar Container Types
The TdxRibbon control can display the following docked toolbar containers depending on the Style property value:
Caption Area Search Toolbar
The Caption Area Search Toolbar allows users to access important functionality through the form caption, similar to the search box found in Microsoft Office® 365 applications.
The caption area search toolbar is available only for the Office 365 Ribbon style. If the parent TdxRibbon control’s Style property is set to a different value (rs2019, for instance), the embedded toolbar automatically moves to the Tab Area Search Toolbar. If the new Ribbon style does not support the Tab Area Search Toolbar (rs2007, rs2010, or rs2013), the toolbar becomes hidden.
The TdxRibbonCaptionAreaSearchToolbar class implements the Caption Area Search Toolbar.
Quick Access Toolbar
The Quick Access Toolbar allows users to access frequently used commands regardless of the active Ribbon tab. Users can customize the Quick Access Toolbar.
All Ribbon styles support the Quick Access Toolbar.
The TdxRibbonQuickAccessToolbar class implements the Quick Access Toolbar.
Tab Area Search Toolbar
Like Caption Area Search Toolbar, the Tab Area Search Toolbar allows users to access important commands without the need to navigate through the Ribbon UI. However, the Tab Area Search Toolbar shares space with Ribbon tabs, like the Tab Area Toolbar.
You can embed a TdxOfficeSearchBox editor into the Tab Area Search Toolbar to imitate the Tell Me box available in Microsoft Office® 2016 and newer versions.
Note
The Tab Area Search Toolbar is not available for Office 2007, Office 2010, and Office 2013 Ribbon styles. A TdxBar instance embedded into the Tab Area Search Toolbar is hidden if the current Ribbon style does not allow the Ribbon control to display the Tab Area or Caption Area Search Toolbar.
The TdxRibbonTabAreaSearchToolbar class implements the Tab Area Search Toolbar.
Tab Area Toolbar
The Tab Area Toolbar is similar to the Tab Area Search Toolbar but is aligned to the right border of the Ribbon UI.
All Ribbon styles support the Tab Area Toolbar.
The TdxRibbonTabAreaToolbar class implements the Tab Area Toolbar.
Main API Members
The list below outlines key members of the TdxRibbonCustomToolbar class. These members allow you to configure settings common to all docked Ribbon toolbar containers.
- Ribbon
- Provides access to the parent TdxRibbon control.
- Toolbar
Specifies the toolbar whose nested bar items are displayed in the docked Ribbon toolbar.
Use this property to display content of a TdxBar instance in the docked Ribbon toolbar.
- Visible
- Allows you to hide or display the docked Ribbon toolbar and its content.
Terminal TdxRibbonCustomToolbar Class References
Do not use the TdxRibbonCustomToolbar class directly. Use the following descendants instead:
- TdxRibbonCaptionAreaSearchToolbar
- Stores settings of the Caption Area Search Toolbar in a Ribbon UI.
- TdxRibbonQuickAccessToolbar
- Contains the Ribbon Quick Access Toolbar‘s settings.
- TdxRibbonTabAreaSearchToolbar
- Contains the Ribbon Tab Area Search Toolbar‘s settings.
- TdxRibbonTabAreaToolbar
- Contains the Ribbon Tab Area Toolbar‘s settings.