TcxCustomGridTableItem Class
The base class for all data items in Table, Banded Table, Card, Layout, and WinExplorer grid Views.
Declaration
TcxCustomGridTableItem = class(
TcxComponent,
IcxEditRepositoryItemListener,
IcxStoredObject,
IdxScaleFactor,
IdxFilterableComponent,
IdxFilterImagesProvider,
IdxExcelFilterableComponent,
IdxCustomFunctionContainer,
IdxCustomFunctionFilterableComponent,
IdxDateTimeHandling,
IdxFilteringDateTimeHandling,
IdxGroupingDateTimeHandling,
IcxDataControllerSpreadSheetExpressionItem
)Remarks
The TcxCustomGridTableItem class implements core functionality common to data items in all grid Views except for Chart in all supported data access modes. A data item is designed to display data of the same type. In bound and server data access modes, a data item corresponds to an individual dataset field.
Data Item Types
Data items are main visual elements of all grid Views. Depending on the View type, data items describe different View elements:
- Column
In a Table or Banded Table View, data items are columns that populate the View from left to right.
- Card Row
In a Card View, items are card rows arranged vertically.
- Layout Data Item
A layout data item is embedded into a layout container.
- WinExplorer Data Item
A WinExplorer data item is an image, text, check box, or group associated with a dataset field.
In-Place Editors
A data item can use any editor shipped with the ExpressEditors Library as an in-place editor for cell edit operations. An in-place editor instance exists (and, therefore, has its own WinAPI handle) only when a data item cell is being edited. Otherwise, the data item displays a static editor image for resource usage optimization.
To switch between available in-place editors, you can use the PropertiesClassName or PropertiesClass property. Use the Properties property to configure the in-place editor associated with the data item.
In-Place Editors and Repository Items
Alternatively, you can assign an edit repository item component to the RepositoryItem property, and use the repository item to define the active in-place editor and customize its settings.
Note
If an edit repository item is assigned to the RepositoryItem property, Properties, PropertiesClass, and PropertiesClassName properties have no effect.
Multiple In-Place Editors in One Data Item
You can handle OnGetProperties and OnGetPropertiesForEdit events to dynamically change the assigned in-place editor and its settings based on custom conditions.
Important
Do not change PropertiesClass, PropertiesClassName, and Properties property values directly in OnGetProperties and OnGetPropertiesForEdit event handlers.
To change the active editor and modify its settings safely within these event handlers, use the RepositoryItem property and TcxEditRepositoryItem class descendants.
Main API Members
The list below outlines key members of the TcxCustomGridTableItem class that allow you to configure columns, card rows as well as layout and WinExplorer items in corresponding grid Views.
- Specify a caption for the data item (Caption).
- Configure data binding settings in the current data access mode (DataBinding).
- Hide or display the data item (Visible).
- Define an alternative caption for the data item (AlternateCaption).
- Identify if the data item is the first or last in the parent collection of visible data items (IsFirst and IsLast).
- Switch between available in-place editor types (PropertiesClass and PropertiesClassName).
- Configure the assigned in-place editor (Properties and RepositoryItem).
- Display different in-place editors for different records based on custom conditions (OnGetProperties).
- Change the assigned in-place editor and its settings when it is invoked (OnGetPropertiesForEdit).
- Activate and deactivate the assigned in-place cell editor (Editing).
- Adjust the column width to display content in full (ApplyBestFit).
- Sort data against the data item (SortIndex and SortOrder).
- Group data items (GroupIndex).
- Scroll the grid View to display the data item (MakeVisible).
- Display custom value display text (OnGetDisplayText).
- Customize data item appearance and behavior settings (Options).
- Apply styles to different data item elements (Styles).
- Custom draw the data item (OnCustomDrawCell).
- Adjust the minimum data item width (MinWidth).
- Customize data item captions displayed in a filter drop-down window (OnGetFilterDisplayText).
- Position the data item header horizontally and vertically (HeaderAlignmentHorz and HeaderAlignmentVert).
- Access the grid View to which the data item belongs (GridView).
Terminal TcxCustomGridTableItem Class Descendants
Do not use the TcxCustomGridTableItem class directly. Use the following descendants instead:
- TcxGridColumn
- An item (column) in a Table View.
- TcxGridBandedColumn
- A column within a Banded Table View.
- TcxGridDBColumn
- A column in a data-aware grid Table View.
- TcxGridDBBandedColumn
- A banded column in a data-aware Banded Table View (TcxGridDBBandedTableView).
- TcxGridServerModeColumn
- A column in a Server Mode Table View.
- TcxGridServerModeBandedColumn
- A column within a Banded Table View with support for server mode.
- TcxGridCardViewRow
- An item in a Card View.
- TcxGridDBCardViewRow
- Represents an item in a data-aware Card View.
- TcxGridLayoutViewItem
- A Layout View‘s data item.
- TcxGridDBLayoutViewItem
- A data-aware Layout View’s data item.
- TcxGridWinExplorerViewItem
- TcxGridDBWinExplorerViewItem