TdxNavBarGroupViewInfo.CaptionGradientMode Method

Returns the gradient direction used to fill the group header’s background.

Declaration

function CaptionGradientMode: TdxBarStyleGradientMode; virtual;

Returns

Type
TdxBarStyleGradientMode

Remarks

Use the CaptionGradientMode function to obtain the gradient direction applied to the group header’s background. 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 CaptionGradientMode function returns the GradientMode property value of the style assigned.

The CaptionGradientMode function can be used when handling the OnCustomDraw.GroupCaption event. It is useful if you don’t want to fill the group header’s background with a custom gradient.