TGridColumns class

In unit Grids

Collection used to store column definitions for a grid control.

Declaration

pascal

TGridColumns = class(TCollection)

Inheritance

Descends from it: TDBGridColumns

Description

TGridColumns is a TCollection descendant that implements a container for column definitions used in TCustomGrid and descendent classes. TGridColumns is the type used to implement the Columns in TCustomGrid.

TGridColumns is used to create, access, and maintain TGridColumn class instances representing the columns in a grid. Use the indexed Items to access a TGridColumn instance in the collection using its ordinal position.

Additional properties and methods are included in the collection that are relevant to their use with grid column definitions. A reference to the TCustomGrid which owns the collection is maintained to provide access to the properties, methods, and events in the grid.

Properties

`Grid`	public	The Grid which owns the collection and columns.
`Items`	public	Provides indexed access to column definitions in the collection.
`VisibleCount`	public	The number of visible columns in the collection.
`Enabled`	public	Indicates if the column collection is enabled.

Methods

`GetOwner`	protected	Returns the owner of the component.
`Update`	protected	Notifies the Grid using the collection when a column is updated.
`TitleFontChanged`	protected	Performs actions needed when the title font is changed for items in the collection.
`FontChanged`	protected	Performs actions needed when the Font for the grid control is changed.
`RemoveColumn`	protected	Removes the specified column number from the collection.
`MoveColumn`	protected	Moves the column from the first index to the second.
`ExchangeColumn`	protected	Exchanges the positions for the specified columns.
`InsertColumn`	protected	Inserts a column at the specified index position.
`Create`	public	Constructor for the class instance.
`Add`	public	Creates a new ItemClass instance with the collection as its owner.
`Clear`	public	Clears all items in the collection.
`ColumnByTitle`	public	Gets the grid column in the collection with the specified title.
`RealIndex`	public	The actual grid index for the visible columns in the collection.
`IndexOf`	public	Gets the ordinal position in the collection for the specified column.
`IsDefault`	public	True if the columns contain default values only.
`HasIndex`	public	True if the specified index value is valid for the collection.
`VisibleIndex`	public	The visible index value for the specified column in the collection.

Inherited

From TCollection (26)

Assign BeginUpdate Changed Count Delete Destroy EndUpdate Exchange FindItemID GetAttr GetAttrCount GetEnumerator GetItem GetItemAttr GetNamePath Insert ItemClass Move Notify Owner PropName SetItem SetItemName SetPropName Sort UpdateCount

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.