Skip to main content

TcxCustomGridColumn Members

The base class for columns in Table and Banded Table grid Views.

Constructors

Name Description
Create(TComponent) Inherited from TComponent.

Properties

Name Description
ActuallyVisible Specifies whether an item can be displayed. Inherited from TcxCustomGridTableItem.
AlternateCaption Specifies an alternative caption for the current item. Inherited from TcxCustomGridTableItem.
BestFitMaxWidth Specifies the item’s (column) maximum width value (in pixels) for the best fit. Inherited from TcxCustomGridTableItem.
Caption Specifies the item’s caption. Inherited from TcxCustomGridTableItem.
ComObject Inherited from TComponent.
ComponentCount Inherited from TComponent.
ComponentIndex Inherited from TComponent.
Components Inherited from TComponent.
ComponentState Inherited from TComponent.
ComponentStyle Inherited from TComponent.
DataBinding Specifies an object linking the current item to data storage. Inherited from TcxCustomGridTableItem.
DateTimeGrouping Specifies time periods used as date/time grouping values in group rows. Inherited from TcxCustomGridTableItem.
DesignInfo Inherited from TComponent.
Editable Inherited from TcxCustomGridTableItem.
Editing Specifies whether the current item is in edit mode. Inherited from TcxCustomGridTableItem.
EditValue Specifies the value stored in the item’s cell in the currently focused record. Inherited from TcxCustomGridTableItem.
FakeComponentLink1 Inherited from TcxComponent.
FakeComponentLink2 Inherited from TcxComponent.
FakeComponentLink3 Inherited from TcxComponent.
Filtered Specifies whether filter criteria are set for the current item (column). Inherited from TcxCustomGridTableItem.
FilteringDateRanges Provides access to the item’s collection of filter date ranges. Inherited from TcxCustomGridTableItem.
FixedKind Specifies the active column anchor mode.
Focused Specifies whether the cell is focused. Inherited from TcxCustomGridTableItem.
FocusedCellViewInfo Inherited from TcxCustomGridTableItem.
FooterAlignmentHorz Specifies the alignment of text in the column’s footer cells.
GridView Provides access to the Table View containing the current column.
GroupIndex Specifies the group index of the item (column). Inherited from TcxCustomGridTableItem.
GroupingDateRanges Provides access to the item’s collection of grouping date ranges. Inherited from TcxCustomGridTableItem.
GroupSummaryAlignment Specifies the horizontal alignment of a group summary in the currently processed column.
HeaderAlignmentHorz Defines the horizontal alignment of the item caption. Inherited from TcxCustomGridTableItem.
HeaderAlignmentVert Specifies the vertical alignment of the item caption. Inherited from TcxCustomGridTableItem.
HeaderGlyph Specifies the column header‘s icon.
HeaderGlyphAlignmentHorz Specifies the horizontal alignment of the column header‘s icon.
HeaderGlyphAlignmentVert Specifies the vertical alignment of the column header‘s icon.
HeaderHint Specifies the hint text that is displayed when the mouse pointer is hovered over an item header. Inherited from TcxCustomGridTableItem.
HeaderImageIndex Specifies the column header’s image from the images collection.
Hidden Specifies whether the item can be displayed within the Customization form. Inherited from TcxCustomGridTableItem.
Hideable Inherited from TcxCustomGridTableItem.
ID Specifies the unique identifier assigned to an item. Inherited from TcxCustomGridTableItem.
IncSearching Indicates whether an incremental search is currently in progress on the current item. Inherited from TcxCustomGridTableItem.
Index Specifies the position of the item within the View’s item collection. Inherited from TcxCustomGridTableItem.
IsBottom Indicates whether the column is displayed at the bottom of the object that owns the column.
IsChildInMergedGroup
IsDesigning Inherited from TcxComponent.
IsDestroying Inherited from TcxComponent.
IsFirst Specifies whether the item is the first within the collection of visible items. Inherited from TcxCustomGridTableItem.
IsLast Specifies whether the item is the last within the collection of visible items. Inherited from TcxCustomGridTableItem.
IsLeft Specifies whether the column is displayed at the left of the object that owns the column.
IsLoading Inherited from TcxComponent.
IsMostBottom Specifies whether the column is bottommost.
IsMostLeft Specifies whether the column is displayed at the left edge of a View.
IsMostRight Returns a value indicating whether the column is positioned at the right edge of a View.
IsPreview Indicates if the column is previewed.
IsRight Specifies whether the column is displayed at the right of the object that owns the column.
IsTop Indicates whether the column is displayed at the top of the object that owns it.
LayoutItem Specifies a layout item that hosts an editor created by an in-place Edit Form for the column.
MinWidth Specifies the minimum width (in pixels) of the cell in which the item’s data is displayed. Inherited from TcxCustomGridTableItem.
Name Inherited from TComponent.
Observers Inherited from TComponent.
Options Defines a set of options managing the behavior and appearance of the column.
Owner Inherited from TComponent.
Properties Provides access to active in-place editor settings. Inherited from TcxCustomGridTableItem.
PropertiesClass Specifies a reference to the editor properties class that corresponds to the active in-place editor type. Inherited from TcxCustomGridTableItem.
PropertiesClassName Specifies the in-place editor type by its class name. Inherited from TcxCustomGridTableItem.
RepositoryItem Specifies an edit repository item component for the grid table item. Inherited from TcxCustomGridTableItem.
RowLayoutItem Specifies the layout item that hosts an editor created by a row layout for the column.
Selected Indicates if the column’s cells are selected within the View.
SortIndex Specifies the index of the current item among sorted items within the current View. Inherited from TcxCustomGridTableItem.
SortOrder Defines the sort order for the item. Inherited from TcxCustomGridTableItem.
Styles Specifies a set of styles managing the appearance of column elements.
Summary Specifies the set of summaries that are calculated for the column.
Tag Inherited from TcxCustomGridTableItem.
VCLComObject Inherited from TComponent.
Visible Specifies whether the item is displayed within a View. Inherited from TcxCustomGridTableItem.
VisibleCaption Inherited from TcxCustomGridTableItem.
VisibleForCustomization Specifies whether an item is shown in the Customization Form when moved into it. Inherited from TcxCustomGridTableItem.
VisibleForEditForm Specifies the column’s availability for an in-place Edit Form.
VisibleForExpressionEditor Specifies if the grid View item is available as a value source for expressions in the “Expression Editor“ dialog. Inherited from TcxCustomGridTableItem.
VisibleForRowLayout Specifies if the column is available in a custom or automatically generated row layout.
VisibleIndex Specifies the position of an item within the collection of items. Inherited from TcxCustomGridTableItem.
Width Specifies the width (in pixels) of the cell in which displays the item’s data. Inherited from TcxCustomGridTableItem.

Methods

Name Description
ApplyBestFit(Boolean,Boolean) Adjusts the width of the View item to display its content in full. Inherited from TcxCustomGridTableItem.
Assign(TPersistent) Inherited from TPersistent.
AssignTo(TPersistent) Inherited from TPersistent.
BeginInvoke(TAsyncConstArrayFunctionEvent,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProc,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProcedureEvent,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncFunctionEvent,TObject) Inherited from TComponent.
BeginInvoke(TAsyncProcedureEvent,TObject) Inherited from TComponent.
BeginInvoke(TProc,TObject) Inherited from TComponent.
BeginInvoke<TResult>(TAsyncConstArrayFunc<TResult>,Untyped[],TObject) Inherited from TComponent.
BeginInvoke<TResult>(TFunc<TResult>,TObject) Inherited from TComponent.
CalculateDefaultCellHeight(TcxCanvas,TFont) Inherited from TcxCustomGridTableItem.
CreateEditStyle Inherited from TcxCustomGridTableItem.
DestroyComponents Inherited from TComponent.
Destroying Inherited from TComponent.
EndFunctionInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult) Inherited from TComponent.
Equals(TObject) Inherited from TObject.
ExecuteAction(TBasicAction) Inherited from TComponent.
FindComponent(String) Inherited from TComponent.
FocusWithSelection Selects the currently processed item. Inherited from TcxCustomGridTableItem.
FreeNotification(TComponent) Inherited from TComponent.
FreeOnRelease Inherited from TComponent.
GetAlternateCaption Returns a string specifying an alternative caption for the current item. Inherited from TcxCustomGridTableItem.
GetChildren(TGetChildProc,TComponent) Inherited from TComponent.
GetDefaultValuesProvider(TcxCustomEditProperties) Inherited from TcxCustomGridTableItem.
GetHashCode Inherited from TObject.
GetNamePath Inherited from TPersistent.
GetOwner Inherited from TPersistent.
GetParentComponent Inherited from TComponent.
GetProperties Inherited from TcxCustomGridTableItem.
GetProperties(TcxCustomGridRecord) Inherited from TcxCustomGridTableItem.
GetProperties(Integer) Returns the properties of an editor used to edit the values of the current item. Inherited from TcxCustomGridTableItem.
GetRepositoryItem Returns a reference to the assigned repository item. Inherited from TcxCustomGridTableItem.
GroupBy(Integer,Boolean,Boolean,Boolean)
HasParent Inherited from TComponent.
InsertComponent(TComponent) Inherited from TComponent.
IsImplementorOf(IInterface) Inherited from TComponent.
Loaded Inherited from TComponent.
MakeVisible Scrolls the View’s content to bring the item into view. Inherited from TcxCustomGridTableItem.
Notification(TComponent,TOperation) Inherited from TComponent.
ReferenceInterface(IInterface,TOperation) Inherited from TComponent.
RemoveComponent(TComponent) Inherited from TComponent.
RemoveFreeNotification(TComponent) Inherited from TComponent.
RestoreDefaults Restores the item’s Caption and Width properties to their default values. Inherited from TcxCustomGridTableItem.
SetParentComponent(TComponent) Inherited from TComponent.
SetSubComponent(Boolean) Inherited from TComponent.
ShowExpressionEditor Invokes the “Expression Editor“ dialog for the item. Inherited from TcxCustomGridTableItem.
ToString Inherited from TObject.
UpdateAction(TBasicAction) Inherited from TComponent.

Events

Name Description
OnCustomDrawCell Occurs when a table cell or a card cell needs to be painted. Inherited from TcxCustomGridTableItem.
OnGetCellHint Fires before the item’s hint is shown when an end-user positions the mouse pointer over the item’s data cell. Inherited from TcxCustomGridTableItem.
OnGetDataText Enables you to specify custom text for cells. The text specified is used for displaying, sorting and grouping purposes. Inherited from TcxCustomGridTableItem.
OnGetDisplayText Occurs when an item value is displayed. Inherited from TcxCustomGridTableItem.
OnGetFilterDisplayText Enables you to customize item captions displayed in the filter dropdown list. Inherited from TcxCustomGridTableItem.
OnGetFilterImages Allows you to replace images displayed in the grid table item’s filter pop-up window. Inherited from TcxCustomGridTableItem.
OnGetFilterValues Enables you to customize the View item’s filter dropdown list (add or remove specific list items). Inherited from TcxCustomGridTableItem.
OnGetProperties Allows you to change the active in-place editor and customize its settings depending on specific conditions. Inherited from TcxCustomGridTableItem.
OnGetPropertiesForEdit Allows you to change the in-place editor and customize its settings when a user invokes it for a data cell in the table item. Inherited from TcxCustomGridTableItem.
OnGetStoredProperties Occurs when the list of the current table item’s properties that will be stored in external storage is produced. Inherited from TcxCustomGridTableItem.
OnGetStoredPropertyValue Occurs when values of the current table item’s properties are stored to external storage. Inherited from TcxCustomGridTableItem.
OnInitFilteringDateRanges Allows you to customize the item’s collection of filter date ranges. Inherited from TcxCustomGridTableItem.
OnInitGroupingDateRanges protected Enables you to customize the item’s collection of grouping date ranges. Inherited from TcxCustomGridTableItem.
OnSetStoredPropertyValue Occurs when values of the current table item’s properties are restored from external storage. Inherited from TcxCustomGridTableItem.
OnUserFiltering Enables you to apply proper filter criteria when a custom created filter item (a fviUser filter value item) is selected from the View item’s filter dropdown. Inherited from TcxCustomGridTableItem.
OnUserFilteringEx Enables you to apply proper filter criteria when a custom created filter item (a fviUserEx filter value item) is selected from the View item’s filter dropdown. Inherited from TcxCustomGridTableItem.
OnValidateDrawValue Enables you to customize the manner in which validation errors are visualized in item cells. Inherited from TcxCustomGridTableItem.
PropertiesEvents Inherited from TcxCustomGridTableItem.
StylesEvents Inherited from TcxCustomGridTableItem.
See Also