TCustomGrid.GetColumnTitle function

Declaration

function GetColumnTitle(Column: Integer): string

Arguments

Function result

Text displayed in the title for the column.

Description

GetColumnTitle is a String function used to get the text displayed as the column title for column number specified in Column. ColumnFromGridColumn is called to get the non-fixed TGridColumn instance at the specified position in the Columns collection.

If a column exists at the position in Column, the Caption stored in its Title property is used as the return value. If Column does not represent a valid non-fixed column position, or the Columns collection has not been enabled, the value from the GetDefaultColumnTitle method is used as the return value.

GetColumnTitle is called from the DrawColumnText method when the image and text for the column header is drawn.