TcxGridColumn Members
A column in an unbound grid Table View.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. |
| Automation | Provides access to data item UI Automation and accessibility-related settings. Inherited from TcxCustomGridTableItem. |
| BestFitMaxWidth | Specifies the item’s (column) maximum width value (in pixels) for the best fit. Inherited from TcxCustomGridTableItem. |
| Caption | Specifies the data 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. Inherited from TcxCustomGridColumn. |
| 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. Inherited from TcxCustomGridColumn. |
| GridView | Provides access to the Table View containing the current column. Inherited from TcxCustomGridColumn. |
| 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. Inherited from TcxCustomGridColumn. |
| 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 glyph. Inherited from TcxCustomGridColumn. |
| HeaderGlyphAlignmentHorz | Specifies the horizontal alignment of the column header glyph. Inherited from TcxCustomGridColumn. |
| HeaderGlyphAlignmentVert | Specifies the vertical alignment of the column header glyph. Inherited from TcxCustomGridColumn. |
| HeaderHint | Specifies the hint text that is displayed when the mouse pointer is hovered over the data item’s header. Inherited from TcxCustomGridTableItem. |
| HeaderImageIndex | Specifies the column header’s image from the images collection. Inherited from TcxCustomGridColumn. |
| Hidden | Deprecated. This property exists for backward compatibility only. Use the VisibleForCustomization property instead. 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 | Identifies if the column is displayed at the bottom of the parent container. Inherited from TcxCustomGridColumn. |
| IsChildInMergedGroup | Inherited from TcxCustomGridColumn. |
| 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. Inherited from TcxCustomGridColumn. |
| IsLoading | Inherited from TcxComponent. |
| IsMostBottom | Specifies if the column is nethermost in the parent container. Inherited from TcxCustomGridColumn. |
| IsMostLeft | Specifies whether the column is displayed at the left edge of a View. Inherited from TcxCustomGridColumn. |
| IsMostRight | Returns a value indicating whether the column is positioned at the right edge of a View. Inherited from TcxCustomGridColumn. |
| IsPreview | Defines whether the column is previewed. |
| IsRight | Specifies whether the column is displayed at the right of the object that owns the column. Inherited from TcxCustomGridColumn. |
| IsTop | Indicates whether the column is displayed at the top of the object that owns it. Inherited from TcxCustomGridColumn. |
| LayoutItem | Specifies a layout item that hosts an editor created by an in-place Edit Form for the column. Inherited from TcxCustomGridColumn. |
| 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. Inherited from TcxCustomGridColumn. |
| Selected | Specifies whether the column’s cells are selected within a (Banded) Table View. |
| SortIndex | Specifies the data item’s index in a complex sort operation applied to the parent grid View. Inherited from TcxCustomGridTableItem. |
| SortOrder | Specifies the sort order of the data item. Inherited from TcxCustomGridTableItem. |
| Styles | Provides access to styles that define the appearance of column elements. Inherited from TcxCustomGridColumn. |
| Summary | Specifies the set of summaries that are calculated for the column. Inherited from TcxCustomGridColumn. |
| Tag | Specifies the integer value associated with the data item. 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. Inherited from TcxCustomGridColumn. |
| 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. Inherited from TcxCustomGridColumn. |
| 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
Events
| Name | Description |
|---|---|
| OnCompareRowValuesForCellMerging | Occurs when the values of two sequential cells in the column are compared to determine if these cells can be merged into a single cell. |
| OnCompareValuesForCellMerging | Occurs when the values of two sequential cells in the column are compared to determine if these cells can be merged into a single cell. |
| OnCustomDrawCell | Occurs every time a table or card cell is about to be drawn. Inherited from TcxCustomGridTableItem. |
| OnCustomDrawFooterCell | Occurs when a footer or group footer cell within the current column is about to be drawn. |
| OnCustomDrawGroupSummaryCell | Fires each time a group summary (that belongs to the currently processed column) is about to be drawn in a group row. |
| OnCustomDrawHeader | Occurs every time a column header is about to be drawn. |
| OnGetCellHint | Occurs before the data item’s hint is shown when a 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. |
| OnHeaderClick | Allows you to respond to clicks on the column header. |
| OnInitFilteringDateRanges | Allows you to customize the item’s collection of filter date ranges. Inherited from TcxCustomGridTableItem. |
| OnInitGroupingDateRanges | 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