Skip to main content
All docs
V24.1

TdxRibbonCaptionAreaSearchToolbar Class

Stores settings of the Caption Area Search Toolbar in a Ribbon UI.

Declaration

TdxRibbonCaptionAreaSearchToolbar = class(
    TdxRibbonCustomToolbar
)

Remarks

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.

VCL Bars: A Caption Area Search Toolbar Example

Supported Ribbon Style

The caption area search toolbar is available only for the Office 365 Ribbon style. If the parent TdxRibbon control’s Style property value changes from rsOffice365 to a different value, the embedded bar automatically moves to the tab area search toolbar.

Tip

Like the tab area search toolbar, the caption area search toolbar can contain multiple bar items.

Main API Members

The list below outlines key members of the TdxRibbonCaptionAreaSearchToolbar class. These members allow you to configure a search toolbar displayed within the caption area of a Ribbon form if the parent TdxRibbon control’s Style property is set to rsOffice365.

Alignment
Allows you to position the search toolbar within the parent Ribbon form’s caption area.
Ribbon
Provides access to the parent TdxRibbon control.
Toolbar
Specifies the toolbar whose nested bar items are displayed in the parent Ribbon form’s caption area.
Visible
Allows you to hide or display the search toolbar.

Other Docked Ribbon Toolbar Container Types

The TdxRibbon control also supports the following docked Ribbon toolbar containers:

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.

Direct TdxRibbonCaptionAreaSearchToolbar Class Reference

The TdxCustomRibbon.CaptionAreaSearchToolbar property references a TdxRibbonCaptionAreaSearchToolbar object.

Inheritance

See Also