Skip to main content

TdxNavBarGroupViewInfo.BgGradientMode Method

Returns the gradient direction for the groups client background.

Declaration

function BgGradientMode: TdxBarStyleGradientMode; virtual;

Returns

Type
TdxBarStyleGradientMode

Remarks

Use the BgGradientMode function to obtain the gradient direction used to fill 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 BgGradientMode function returns the BgGradientMode property value of the style assigned.

The BgGradientMode function can be used when handling the OnCustomDraw.GroupClientBackground event. It is useful if you don’t want to use custom gradient direction.

The table below enumerates the gradient modes available.

Value Descriptions
gmHorizontal The gradient has a left to right horizontal direction.
gmVertical The gradient has a top to bottom vertical direction.
gmForwardDiagonal The gradient has a left top to right bottom direction.
gmBackwardDiagonal The gradient has a right top to left bottom direction.
See Also