Sign in Join
FPDoc Onlineexperiment

TColumn class

In unit DBGrids

Implements a display column for the TDBGrid control.

Declaration

pascal
TColumn = class(TGridColumn)

Inheritance

  1. TColumn
  2. TGridColumn
  3. TCollectionItem
  4. TPersistent
  5. TObject

Description

TColumn is a TGridColumn descendant that represents a display column in a database grid control. TColumn extends the ancestor class to provide support for using TField for data access, display formatting, alignment, as well as use of check box and lookup list Fields. TColumn also implements support for features in TDBGrid like: automatic rows, and design-time vs run-time column ordering.

TColumn provides properties and methods needed to access and maintain the Dataset, Field, FieldName, and DisplayFormat for the column. TColumn provides overridden functions which implement facilities from the ancestor class.

TColumn instances can be created at run-time or design-time; properties are provided to indicate when the instance was created. The display order for columns need not correspond to the order of the Fields in the dataset, nor do all Fields in the dataset need to be represented by a display column.

TColumn instances are used as the collection item for the TDBGridColumns collection.

See also

Properties

IsAutomaticColumnprotectedIndicates if the column was automatically added at run-time.
IsDesignColumnprotectedIndicates if the column was added at design-time.
DesignIndexpublicOrder for the column in its collection at design-time.
FieldpublicField in the Dataset associated with this Column.
FieldNamepublishedName of the Field with data for the column.
DisplayFormatpublishedThe format to be used for display in this column.

Methods

CreateTitleprotectedCreates the title used for the grid column.
GetDefaultAlignmentprotectedGets the default alignment for the Field in the column definition.
GetDefaultDisplayFormatprotectedGets the default display format for the Field in a column.
GetDefaultValueCheckedprotectedGets the default value for a check box in the Checked state as a String.
GetDefaultValueUncheckedprotectedGets the default String value for a check box in the UnChecked state.
GetDefaultVisibleprotectedIndicates if the Field for the column is Visible.
GetDisplayNameprotectedGets the display name for the collection item.
GetDefaultReadOnlyprotectedGets the default value for the ReadOnly property.
GetDefaultWidthprotectedGets the effective width for the column.
GetPickListprotectedGets the values in the pick list for the column.
LinkFieldprotectedEstablishes a link between the FieldName and the Field in a Dataset.
CreatepublicConstructor for the TColumn instance.
AssignpublicStores properties from a persistent class in the current class instance.
IsDefaultpublicIndicates if the column uses its default display format.

Inherited

From TGridColumn (37)

Alignment AllColumnsChange ButtonStyle Color ColumnChanged DefaultWidth Destroy DropDownRows Expanded FillDefaultFont FixDesignFontsPPI Font GetDefaultColor GetDefaultLayout GetDefaultMaxSize GetDefaultMinSize GetDefaultSizePriority GetValueChecked GetValueUnchecked Grid IsDefaultFont Layout MaxSize MinSize PickList ReadOnly ScaleFontsPPI SetIndex SizePriority StoredWidth Tag Title ValueChecked ValueUnchecked Visible Width WidthChanged

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.