Back to Devexpress

TdxCustomBarEdit Class

vcl-dxbar-115fc43d.md

latest3.9 KB
Original Source

TdxCustomBarEdit Class

The base class for toolbar edit items.

Declaration

delphi
TdxCustomBarEdit = class(
    TdxBarWindowItem
)

Remarks

The TdxCustomBarEdit class implements a toolbar item container that allows you to use an editor from the ExpressEditors Library in the same manner as in other container controls, such as VCL Data Grid, Tree List, Vertical Grid, etc.

Main API Members

The list below outlines key members of the TdxCustomBarEdit class. These members allow you to configure toolbar edit items.

Appearance Settings

CaptionSpecifies the toolbar item’s caption.Glyph | ImageIndexAllow you to assign a glyph to the editor when it is displayed in a standard-sized toolbar item.LargeGlyph | LargeImageIndex

Allow you to assign a different glyph to the editor when it is displayed in a large button or menu item.

Tip

You can use the vector image assigned through the Glyph or ImageIndex property as a glyph for both toolbar item sizes if the BarManager.ImageOptions.SVGOptions.UseRegularAsLarge property is set to True ( default ).

ShowCaption

Specifies if the toolbar item caption is visible on the parent toolbar.

Note

This setting has no effect when the editor is displayed in a Ribbon UI. Editor caption visibility in a Ribbon UI depends on the layout, form width, etc.

Style | StyleEditSpecify appearance styles for the toolbar item and its in-place editor.

Behavior Settings

ScreenTipAllows you to associate the toolbar edit item with a screen tip (advanced hint).ShortCutSpecifies the key combination associated with the toolbar edit item.

General-Purpose API Members

AlignAllows you to position the toolbar edit item within the parent toolbar area.DescriptionSpecifies the toolbar edit item’s description displayed in the Customization Form.EnabledSpecifies if the toolbar item and its in-place editor are enabled.BarManagerProvides access to the parent Bar Manager component.VisibleSpecifies if the toolbar edit item is visible.WidthAllows you to adjust the width of the in-place editor assigned to the toolbar edit item.

Terminal TdxCustomBarEdit Class Descendant

Do not use the TdxCustomBarEdit class directly. Use the TcxBarEditItem component instead.

Inheritance

TObject TPersistent TComponent TcxCustomComponent TdxBarComponent TdxBarItem TdxBarWindowItem TdxCustomBarEdit

See Also

TdxCustomBarEdit Members

dxBar Unit