TCustomGrid.GetCellHintText function

Declaration

function GetCellHintText(ACol: Integer; ARow: Integer): string
 ; virtual

Arguments

Function result

String with the hint text for the specified cell.

Description

GetCellHintText signals the OnGetCellHint event handler (when assigned) to get the hint text for the cell at the position in ACol and ARow. The return value contains the hint text returned from the event handler, or an empty string ( '') when the event handler has not been assigned.

GetCellHintText is called from the ShowCellHintWindow method when Options contains the value goCellHints and CellHintPriority is not set to chpTruncOnly.

See also

• OnGetCellHint
• ShowCellHintWindow
• Options
• CellHintPriority
• GetTruncCellHintText