TdxNavBarGroupViewInfo.BgImage Method

Returns the background image applied to the group client area.

Declaration

function BgImage: TPicture; virtual;

Returns

Type
TPicture

Remarks

Use the BgImage function to obtain the image assigned to the group’s client background. This value is specified by the style applied to the group. Group background style can be specified for all groups via the OptionsStyle.DefaultStyles.GroupBackground default style. Individual groups can override these settings by assigning a custom style to the CustomStyles.Background property of the group. The BgImage function returns the Image property value of the style assigned.

The BgImage function can be used when handling the OnCustomDraw.GroupClientBackground event. It is useful if you don’t want to display custom image in the group’s client background.