Sign in Join
FPDoc Onlineexperiment

TGridColumnTitle class

In unit Grids

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

Declaration

pascal
TGridColumnTitle = class(TPersistent)

Inheritance

  1. TGridColumnTitle
  2. TPersistent
  3. TObject

Descends from it: TColumnTitle

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:

  • Alignment
  • Color
  • Font
  • ImageIndex
  • ImageLayout
  • Layout
  • MultiLine
  • PrefixOption

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

Properties

ColumnpublicThe TGridColumn instance where the title is used.
AlignmentpublishedHorizontal alignment for the text in the column title.
CaptionpublishedText displayed as the title for the grid column.
ColorpublishedThe background color for the column title.
FontpublishedContains the typeface and text attributes for the Caption displayed in the column title.
ImageIndexpublishedOrdinal position for the image displayed in the fixed header for the column title.
ImageLayoutpublishedThe layout used for any image in the column title.
LayoutpublishedVertical alignment for the Caption text displayed in the column title.
MultiLinepublishedIndicates whether the column title can be displayed as multiple lines.
PrefixOptionpublishedIndicates if accelerator keys are used in the column title.

Methods

GetDefaultCaptionprotectedReturns the default caption for the column title.
GetDefaultAlignmentprotectedReturns the default alignment for the column title.
GetDefaultColorprotectedReturns the default color for the column title.
GetDefaultLayoutprotectedReturns the default layout for the column title.
GetOwnerprotectedGets the persistent object which owns the class instance.
GetCaptionprotectedGets the value for the Caption property.
SetCaptionprotectedSpecifies the caption used for the column title.
DefinePropertiesprotectedSpecifies which properties in the persistent object are used during LCL component streaming.
CreatepublicConstructor for the class instance.
DestroypublicDestructor for the class instance.
AssignpublicCopies property value from the specified persistent object into the current class instance.
FillTitleDefaultFontpublicStores the default font used for the column title.
FixDesignFontsPPIpublicCorrects the design-time PPI for the column title.
ScaleFontsPPIpublicScales font sizes in the class instance to the specified display density.
IsDefaultpublicReturns True if the column title uses the default property values.

Inherited

From TPersistent (5)

AssignTo FPOAttachObserver FPODetachObserver FPONotifyObservers GetNamePath

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.