Skip to main content

TdxNavBarGroupViewInfo.CaptionHAlignment Method

Returns the horizontal alignment of the group header’s text.

Declaration

function CaptionHAlignment: TdxBarStyleHAlignment; virtual;

Returns

Type
TdxBarStyleHAlignment

Remarks

Use the CaptionHAlignment function to obtain the horizontal alignment of the group header’s text. This value is specified by the style applied to the group. Group header’s background style can be specified for all groups via the OptionsStyle.DefaultStyles.GroupHeader, OptionsStyle.DefaultStyles.GroupHeaderActive, OptionsStyle.DefaultStyles.GroupHeaderHotTracked and OptionsStyle.DefaultStyles.GroupHeaderPressed default styles. Individual groups can override these settings by assigning a custom style to the CustomStyles.Header, CustomStyles.HeaderActive, CustomStyles.HeaderHotTracked and CustomStyles.HeaderPressed properties of the group. The CaptionHAlignment function returns the HAlignment property value of the style assigned.

The CaptionHAlignment function can be used when handling the OnCustomDraw.GroupCaption event. It is useful if you don’t want to use custom text alignment.

The table below enumerates the available alignment values.

Value Description
haLeft Caption text is aligned to the left.
haCenter Caption text is centered.
haRight Caption text is aligned to the right.
See Also