TdxNavBarGroupViewInfo.CaptionImage Method

Returns the image used to fill the group header’s background.

Declaration

function CaptionImage: TPicture; virtual;

Returns

Type
TPicture

Remarks

Use the CaptionImage function to obtain the image used to fill the group header’s background. This image 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 CaptionImage function returns the Image property value of the style assigned.

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