Skip to main content

Properties

EhLib TeamAbout 6 min

TDataGridEh Published Properties


AutoGenerateColumns

property AutoGenerateColumns: Boolean default True;

published

Determines whether to create dynamic columns in the grid based on the data source fields specified by the DataSource property.

Set this value to True to have the grid automatically create columns in the grid based on the data source fields.

When creating columns, the grid will only create columns for those fields that do not have columns created in the StaticColumns collection.

This way, the grid can contain static and dynamic columns at the same time.

ColumnOptions

property ColumnOptions: TDataGridColumnOptionsEh;

published

Use the subproperties of the ColumnOptions property to set the default value for the properties of all grid columns.

ColumnOptions is of type TDataGridColumnOptionsEh and is described in detail in the TDataGridEh.ColumnOptions section.


DataSource

    property DataSource: TComponent;

published

The DataSource property can be assigned components of the following types:

  • TDataSource type. With this connection, the grid will work via the standard TDataGridEh - TDataSetTableLinkEh - TDataSource - TDataSet link. In this case, the grid creates an internal TDataSetTableLinkEh object and uses it to create the specified link.

  • TDataSet type. With this connection, the grid will work via the standard TDataGridEh - TDataSetTableLinkEh - TDataSource - TDataSet link. In this case, the grid will create internal TDataSource and TDataSetTableLinkEh objects and use them to create the specified link.

  • TDataSetTableLinkEh type. With this connection, the grid will work via the TDataGridEh - TDataSetTableLinkEh - TDataSource - TDataSet link. In this case, the developer must create TDataSource and TDataSet objects in advance and connect them to the specified TDataSetTableLinkEh object.

  • TListTableLinkEh type. This class is designed to connect TDataGridEh to the object if TList type.

  • TListTableLinkEh\<T> type. This class is designed to connect TDataGridEh to the object if TList<T> type.

In the current version of the library, when connecting a data source of type TListTableLinkEh or TListTableLinkEh\<T> to the grid, the grid can only work in ReadOnly mode.

EditActions

property EditActions: TGridEditActionsEh;

published

Use this property to set allowed operations with the clipboard, editing, and keyboard navigation.

The EditActions property is of type TGridEditActionsEh and is described in detail in the TDataGridEh.EditActions section.

property Footer: TDataGridFooterEh;

published

Use this property to create and customize footer entries in the grid.
To make the values ​​appear in the footer cells, you need to set the Footer property for the grid column.

The Footer property is of type TDataGridFooterEh and is described in detail in the TDataGridEh.Footer section.

GridLineOptions

property GridLineOptions: TDataGridLineOptionsEh;

published

Use this property to customize cell separator lines.

The GridLineOptions property is of type TDataGridLineOptionsEh and is described in detail in the TDataGridEh.GridLineOptions section.

HorzScrollBar

property HorzScrollBar: TDataGridHorzScrollBarEh;

published

Use this property to customize the display of the horizontal scrollbar in the grid.

The HorzScrollBar property is of type TDataGridHorzScrollBarEh and is described in detail in the TDataGridEh.HorzScrollBar section.

IndicatorColumn

property IndicatorColumn: TDataGridIndicatorColumnEh;

published

Use this property to customize the first indicator column in the grid.

The IndicatorColumn property is of type TDataGridIndicatorColumnEh and is described in detail in the TDataGridEh.IndicatorColumn section.

IndicatorTitle

property IndicatorTitle: TDataGridIndicatorTitleEh;

published

Use this property to customize Top Left cell (IndicatorTitle cell) in the grid.

The IndicatorTitle property is of type TDataGridIndicatorTitleEh and is described in detail in the TDataGridEh.IndicatorTitle section.

ReadOnly

property ReadOnly: Boolean default False;

published

Determines whether changing any data in the grid is prohibited.

SearchPanel

property SearchPanel: TDataGridSearchPanelEh;

published

Use this property to set up a dedicated search bar at the top of the grid for searching and filtering data in the grid.

The SearchPanel property is of type TDataGridSearchPanelEh and is described in detail in the TDataGridEh.SearchPanel section.

SelectionOptions

property SelectionOptions: TDataGridSelectionOptionsEh;

published

Use the subproperties of the SelectionOptions property to set display options for the selected area of ​​the grid.

The SelectionOptions property is of type TDataGridSelectionOptionsEh and is described in detail in the TDataGridEh.SelectionOptions section.

Title

property Title: TDataGridTitleBarEh;

published

Use this property to customize the display of top headers in grid columns.

You can customize such parameters as: Header visibility, Font, Fill, Text alignment, Visibility of dividing lines, Display of sorting icons, Display of drop-down windows for filtering data, Ability to create complex headings and other parameters.

The Title property is of type TDataGridTitleBarEh ....

VertScrollBar

property VertScrollBar: TDataGridVertScrollBarEh;

published

Use this property to customize the display of the vertical scrollbar in the grid.

The VertScrollBar property is of type TDataGridVertScrollBarEh ....

TDataGridEh Public Properties

AutoFitColWidths

property AutoFitColWidths: Boolean;

public readonly

Returns True if at least one visible column has a ColSizeUnit property value equal to TGridColSizeUnitEh.Weight.

Bof

property Bof: Boolean;

public readonly

Returns True if the grid is on the first row.

Center

property Center: TDataGridEhCenter;

public

Reference to the TDataGridEhCenter class that contains global methods and properties for all TDataGridEh objects in the project.
For example: TDataGridEhCenter contains the procedure ApplySorting(AGrid: TCustomGridEh) method that performs sorting for each grid in the project. You can create a TDataGridEhCenter inheritor to override the way data is sorted in the grid.
Use the global function function SetDBGridEhCenter(NewGridCenter: TDataGridEhCenter): TDataGridEhCenter; to register a new global object that will define and perform some global functions in the grid. Alternatively, you can create your own TDataGridEh inheritor and override virtual methods in it. If you create a TDataGridEhCenter inheritor and use the SetDBGridEhCenter method, you can override some grid functionality without inheriting the TDataGridEh class.

Columns

property Columns: TDataGridAllColumnsEh;

public

List of all columns in the data grid. Some columns may not be visible in the grid if they have the Visible = False property, but such columns will still be present in the Columns collection. This collection includes a set of static and dynamic columns.

CurrentColIndex

property CurrentColIndex: Integer;

public

The index of the column in the VisibleColums collection where the current cell currently resides.

CurrentColumn

property CurrentColumn: TDataGridBaseColumnEh;

public readonly

The data grid column in the VisibleColums collection where the current cell currently resides.

CurrentRow

property CurrentRow: TDataGridRowEh;

public

The data grid row in the VisibleRows collection where the current cell currently resides.

CurrentRowIndex

property CurrentRowIndex: Integer;

public

The index of the row in the VisibleRows collection where the current cell currently resides.

DataRowCount

property DataRowCount: Integer; readonly;

public

Count of Rows in the VisibleRows collection and in the DataGridEh in the DataRows area.

DisplayColumns

property DisplayColumns: TDataGridDisplayColumnsEh;

public

The DisplayColumns collection contains a list of all grid columns in the order they are displayed on the screen. Some columns may not be visible in the grid if they have Visible = False. The column number in DisplayColumns can be obtained using the TDataGridColumnEh.DisplayIndex property. The Columns collection, unlike DisplayColumns, contains columns in the order they were created and added to the StaticColumns and DynamicColumns collections.

DynamicColumns

property DynamicColumns: TDataGridDynamicColumnsEh;

public

The DynamicColumns collection contains a list of columns that were created automatically based on fields from TableView.Fields. The TableView.Fields list corresponds to DataSet fields or properties of an element in the TList class. DynamicColumns is populated only if AutoGenerateColumns = True. A column is not added to DynamicColumns for a field that already has a column created in the StaticColumns collection.

Eof

property Eof: Boolean;

public

There is no description for this property yet.

FooterRowCount

property FooterRowCount: Integer;

public readonly

There is no description for this property yet.

GridHasAutoRowHeightColumns

property GridHasAutoRowHeightColumns: Boolean;

public readonly

There is no description for this property yet.

GridHasAutoRowHeightColumns

property GridMouseStateManage: TDataGridMouseStateManagerEh;

public readonly

There is no description for this property yet.

HorzAxis

property HorzAxis: TCustomGridAxisDataEh;

public

There is no description for this property yet.

SearchPanelMode

property SearchPanelMode: Boolean;

public

SearchPanelMode = True when text editor in the SearchPanel has a input focus.

SelectedRows

property SelectedRows: TDataGridSelectedRowsEh;

public

List of selected rows in multiselect mode.

Selection

property Selection: TDataGridSelectionEh;

public

Contains information about the selected area of ​​the grid. The selected area can be of a certain type:
Entire grid, Selected records, Selected columns, a selected rectangular area of ​​data cells, nothing selected.

The selected area is usually used to copy the selected data to the clipboard.

StartDataColIndex

property StartDataColIndex: Integer;

public

There is no description for this property yet.

StartDataRowIndex

property StartDataRowIndex: Integer;

public

There is no description for this property yet.

StaticColumns

property StaticColumns: TStaticColumnsEh;

public

A collection of columns that the developer created at run-time or design-time.

StylePainter

property StylePainter: TDataGridStylePainterEh;

public

There is no description for this property yet.

TableView

property TableView: TDataGridRowsViewEh;

public

A reference to an object that contains references to data for display and editing in the grid.

VertAxis

property VertAxis: TCustomGridAxisDataEh;

public

There is no description for this property yet.

VisibleColumns

property VisibleColumns: TDataGridVisibleColumnsEh;

public

A collection of columns that are currently visible in the grid (Column.Visible = True). The order in which columns are stored in the collection corresponds to the Column.VisibleIndex property.

VisibleRows

property VisibleRows: TDataGridRowsEh;

public

A collection of data rows that are currently visible in the grid. The row can be hidden if a filter is set in the grid via ColumnTitle DropDownFilter or via SearchPanel.

https://www.ehlib.com
Copyright © 2025 EhLib Team