Unit 'Grids' Package
[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] [#lcl]

TGridColumnTitle

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Provides properties and methods need to represent a column title in a grid.

Declaration

Source position: grids.pas line 442

type TGridColumnTitle = class(TPersistent)

protected

  function GetDefaultCaption; virtual;

  

Returns the default caption for the column title.

  function GetDefaultAlignment;

  

Returns the default alignment for the column title.

  function GetDefaultColor;

  

Returns the default color for the column title.

  function GetDefaultLayout;

  

Returns the default layout for the column title.

  function GetOwner; override;

  

Gets the persistent object which owns the class instance.

  function GetCaption;

  

Gets the value for the Caption property.

  procedure SetCaption(); virtual;

  

Specifies the caption used for the column title.

  procedure DefineProperties(); override;

  

Specifies which properties in the persistent object are used during LCL component streaming.

public

  constructor Create(); virtual;

  

Constructor for the class instance.

  destructor Destroy; override;

  

Destructor for the class instance.

  procedure Assign(); override;

  

Copies property value from the specified persistent object into the current class instance.

  procedure FillTitleDefaultFont;

  

Stores the default font used for the column title.

  procedure FixDesignFontsPPI(); virtual;

  

Corrects the design-time PPI for the column title.

  procedure ScaleFontsPPI(); virtual;

  

Scales font sizes in the class instance to the specified display density.

  function IsDefault;

  

Returns True if the column title uses the default property values.

  property Column: TGridColumn; [r]

  

The Column to which the title applies.

published

  property Alignment: TAlignment; [rws]

  

The Alignment (whether justified or centered) for the column title.

  property Caption: TCaption; [rws]

  

The Caption for the column title.

  property Color: TGraphicsColor; [rws]

  

The Color for the column title.

  property Font: TFont; [rws]

  

The Font for the column title.

  property ImageIndex: Integer; [rw]

  

The index for the image used in the title (default=0, i.e. no image).

  property ImageLayout: TButtonLayout; [rw]

  

The layout used for any image in the column title.

  property Layout: TTextLayout; [rws]

  

The layout used for the text in the column title.

  property MultiLine: Boolean; [rw]

  

Indicates if the column title can be displayed as multiple lines.

  property PrefixOption: TPrefixOption; [rw]

  

Indicates if accelerator keys are used in the column title.

end;

Inheritance

TGridColumnTitle

  

Provides properties and methods need to represent a column title in a grid.

|

TObject

Description

TGridColumnTitle is TPersistent descendant used to represent properties and methods for the title for a column in a grid. Use the published properties in the class to access the layout and display attributes for the column title, including:

Use the Caption to read or write the text displayed as the title for a grid column.

Use the Column to read the column reference (assigned in the constructor for the class instance) to which the column title is attached.

TGridColumnTitle is the type used to implement the TGridColumn.Title property.

See also

TGridColumn.Title

  

Text displayed as the column title.

TGridColumnTitle.Caption

  

The Caption for the column title.

TGridColumnTitle.Column

  

The Column to which the title applies.

TGridColumnTitle.Alignment

  

The Alignment (whether justified or centered) for the column title.

TGridColumnTitle.Color

  

The Color for the column title.

TGridColumnTitle.Font

  

The Font for the column title.

TGridColumnTitle.ImageIndex

  

The index for the image used in the title (default=0, i.e. no image).

TGridColumnTitle.ImageLayout

  

The layout used for any image in the column title.

TGridColumnTitle.Layout

  

The layout used for the text in the column title.

TGridColumnTitle.MultiLine

  

Indicates if the column title can be displayed as multiple lines.

TGridColumnTitle.PrefixOption

  

Indicates if accelerator keys are used in the column title.