TGridColumn class

In unit Grids

Implements a column definition used for tabular data in TCustomGrid.

Declaration

pascal

TGridColumn = class(TCollectionItem)

Inheritance

Descends from it: TColumn

Description

TGridColumn is a TCollectionItem descendant which implements a column definition for grid controls. TGridColumn contains properties which control the appearance, layout, and editing behavior used for a column in TCustomGrid and descendent classes. For instance:

Alignment
ButtonStyle
Color
DropDownRows
Font
Layout
MinSize
MaxSize
PickList
ReadOnly
Width
Visible
ValueChecked
ValueUnchecked

The column has an associated TGridColumnTitle class instance in Title that defines the fixed cell header displayed for the column. As a convenience, the column includes a reference to the TCustomGrid which uses the column definition.

Instances of TGridColumn are created by and stored in the TGridColumns collection class. Use the methods in TGridColumns to create, access, and maintain the items in the collection.

Properties

`IsDefaultFont`	protected	Indicates if the default font is in use for the grid column.
`Grid`	public	The grid control to which this column belongs.
`DefaultWidth`	public	Default width for the column, or -1 when not assigned.
`StoredWidth`	public	Contains the explicit, non-default value assigned to the Width property.
`WidthChanged`	public	True when the width for the column has been changed.
`Alignment`	published	Indicates the alignment for values displayed in the column: left or right aligned, or centered.
`ButtonStyle`	published	The style used for a button displayed for cells in the column.
`Color`	published	Color for the background on the column.
`DropDownRows`	published	The number of rows displayed in the drop-down list for a cell editor in the column.
`Expanded`	published	Indicates if the drop-down list in the column cell editor is displayed in an expanded state.
`Font`	published	The font used for text displayed in the column.
`Layout`	published	The layout (vertical alignment) for text displayed in the column.
`MinSize`	published	The minimum size for the column in pixels.
`MaxSize`	published	The maximum size for the column in pixels.
`PickList`	published	The list with the values that can be selected for a cell in the column using a drop-down list.
`ReadOnly`	published	True if the values in the column cannot be changed at run-time using the cell editor.
`SizePriority`	published	The auto-sizing priority for the column.
`Tag`	published	Contains a Pointer to an Integer type.
`Title`	published	Contains the attributes for the title in the fixed header for the column.
`Width`	published	The display width in pixels for the column on its Grid control.
`Visible`	published	True if the column is visible (not hidden) on the Grid control.
`ValueChecked`	published	Contains the checked value for a check box in the column.
`ValueUnchecked`	published	Contains the unchecked value for a check box in the column.

Methods

`GetDisplayName`	protected	Returns the of the collectionitem.
`GetDefaultAlignment`	protected	Gets the default value for the Alignment property.
`GetDefaultColor`	protected	Gets the default value for the Color property.
`GetDefaultLayout`	protected	Default layout used for text in the grid column.
`GetDefaultMaxSize`	protected	Gets the default value for the MaxSize property.
`GetDefaultMinSize`	protected	Gets the default value for the MinSize property.
`GetDefaultReadOnly`	protected	Gets the default value for the ReadOnly property.
`GetDefaultSizePriority`	protected	Gets the default value for the SizePriority property.
`GetDefaultVisible`	protected	Gets the default value for the Visible property.
`GetDefaultValueChecked`	protected	Gets the default value for a checked cell in the grid column.
`GetDefaultValueUnchecked`	protected	Gets the default value for an unchecked cell in the column.
`GetDefaultWidth`	protected	Gets the default value for the Width property.
`GetPickList`	protected	Gets the list of strings in the picklist.
`GetValueChecked`	protected	Gets the value for the ValueChecked property.
`GetValueUnchecked`	protected	Gets the value for the ValueUnChecked property.
`ColumnChanged`	protected	Performs actions needed when a column in the grid is changed.
`AllColumnsChange`	protected	Method used to indicate that all columns in the collection have been changed.
`CreateTitle`	protected	Creates a column title used for the grid column.
`SetIndex`	protected	Sets the value for the Index property.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`Assign`	public	Copies property values from the specified persistent object to the current class instance.
`FillDefaultFont`	public	Sets the Font to the value used in the grid control.
`FixDesignFontsPPI`	public	Corrects the design-time PPI for the column title.
`ScaleFontsPPI`	public	Scales the fonts for the column to a specified display density using a scaling factor.
`IsDefault`	public	Indicates if default layout settings are used for the grid column.

Inherited

From TCollectionItem (9)

Changed Collection DisplayName GetNamePath GetOwner ID Index SetCollection SetDisplayName

From TPersistent (5)

AssignTo DefineProperties FPOAttachObserver FPODetachObserver FPONotifyObservers

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.