TcxCustomGridTableItem.HeaderHint Property

Specifies the hint text that is displayed when the mouse pointer is hovered over an item header.

Declaration

property HeaderHint: string read; write;

Property Value

Type
string

Remarks

The hint text specified by the HeaderHint property is alternative to the hint text specified by the column’s Caption property – if specified, the HeaderHint property overrides the column’s Caption property.

The HeaderHint property is primarily used as an explanatory text for the item header’s glyph if the header caption is empty or is not quite evident.

For hint display, the following rules are taken into consideration:

• The hint provided by the HeaderHint property is always enabled if the View’s OptionsBehavior.ColumnHeaderHints property is True. The hint is displayed if the mouse pointer is hovered over any visual element of the item header, except for the filter button.

• The hint provided by the column’s Caption property is automatically enabled if the item header is clipped, and the View’s OptionsBehavior.ColumnHeaderHints property is True. The hint is displayed only if the mouse pointer is hovered over the item header caption.