Skip to content

TTMSFNCDataGridData

Data class used in TTMSFNCDataGrid
Inherits from TTMSFNCDataGridCore

Properties

Property Description
Adapter Gets or sets the data adapter for the grid.
Booleans[AColumn, ARow: Integer] Gets or sets the boolean value of a cell.
CellDataDictionary Gets the cell data dictionary.
CellDataExtended[AColumn, ARow: Integer] Gets extended cell data.
CellData[AColumn, ARow: Integer] Gets cell data.
Cells[AColumn, ARow: Integer] Gets or sets the value of a cell.
ColumnCalculations[AColumn: Integer; AName: string] Gets or sets column calculations.
Controls[AColumn, ARow: Integer] Gets or sets controls in a cell.
FilterBuilder Gets or sets the advanced data filter.
Filter Gets or sets the data filter.
Floats[AColumn, ARow: Integer] Gets or sets the float value of a cell.
GroupDictionary Gets the group dictionary.
GroupInfo Gets the active grouping information after calling Group().
HasColumnCalculations[AColumn: Integer; AName: string] Checks if column has calculations.
HasRowCalculations[ARow: Integer; AName: string] Checks if row has calculations.
Ints[AColumn, ARow: Integer] Gets or sets the integer value of a cell.
ManagedObjects[AColumn, ARow: Integer] Gets or sets managed objects in a cell.
Objects[AColumn, ARow: Integer] Gets or sets objects in a cell.
Options Gets or sets data grid options.
RowCalculations[ARow: Integer; AName: string] Gets or sets row calculations.
RowNodeChildCount[ARow: Integer] Gets or sets the child count of a row node.
RowNodeLevel[ARow: Integer] Gets or sets the level of a row node.
RowNodeState[ARow: Integer] Gets or sets the state of a row node.
RowText[ARow: Integer] Gets or sets the text of a row.
RowTypes[ARow: Integer] Gets or sets the type of a row.
SortIndexList Gets sort indexes.
StoredCells[AColumn, ARow: Integer] Gets stored cell values.
Strings[AColumn, ARow: Integer] Gets or sets string values in a cell.
StrippedCells[AColumn, ARow: Integer] Gets stripped cell values.

Events

Event Description
OnBeforeSetColumnCalculation Triggered before the value of a column calculation is set in the cell.
OnAfterSetColumnCalculation Triggered after the value of a column calculation is set in the cell.
OnBeforeSetRowCalculation Triggered before the value of a row calculation is set in the cell.
OnAfterSetRowCalculation Triggered after the value of a row calculation is set in the cell.
OnCustomColumnCalculation Triggered for custom column calculations.
OnCustomCompare Triggered for custom comparison of values in cells.
OnCustomRowCalculation Triggered for custom row calculations.
OnGetCellDataProperties Provides access to modify cell data properties before rendering.
OnGetCellData Triggered when retrieving data for a specific cell.
OnGetCellDisplayValue Triggered to get the display value of a cell.
OnGetCellFormatting Triggered to provide custom formatting for cells.
OnGetColumnCalculationOptions Provides options for column calculations.
OnGetCustomGroup Triggered for custom group logic.
OnGetGroupOptions Provides options for grouping.
OnGetRowCalculationOptions Provides options for row calculations.
OnGetSortOptions Provides sorting options for the grid.
OnLoadCellData Triggered when loading cell data into the grid.
OnRowCollapse Triggered when a row node is collapsed.
OnRowExpand Triggered when a row node is expanded.
OnSaveCellData Triggered when saving cell data from the grid.

Methods

Method Description
AddColumn Adds a new column to the grid.
AddNodeRow(ARow: Integer; AChildCount: Integer; ALevel: Integer = 0; AMerge: Boolean = True) Adds a node row.
AddRow Adds a new row to the grid.
ApplyFilter Applies the current filter.
AutoNumberColumn(AColumn: Integer; AStartRow: Integer = 0; AStartValue: Integer = 0) Auto numbers a column.
AutoNumberRow(ARow: Integer; AStartColumn: Integer = 0; AStartValue: Integer = 0) Auto numbers a row.
BaseCell(ACell: TTMSFNCDataGridCellCoord): TTMSFNCDataGridCellCoord Gets the base cell for a given cell.
BeginUpdate Begins updating the grid.
CanDeleteColumn(AColumn: Integer): Boolean Checks if a column can be deleted.
CanDeleteRow(ARow: Integer): Boolean Checks if a row can be deleted.
CanInsertColumn(AColumn: Integer): Boolean Checks if a column can be inserted.
CanInsertRow(ARow: Integer): Boolean Checks if a row can be inserted.
CanMergeCells(AColumn, ARow, AColumnCount, ARowCount: Integer): Boolean Checks if cells can be merged.
CanMoveColumn(AFromColumn, AToColumn: Integer): Boolean Checks if a column can be moved.
CanMoveRow(AFromRow, AToRow: Integer): Boolean Checks if a row can be moved.
CanSwapColumn(AFromColumn, AToColumn: Integer): Boolean Checks if columns can be swapped.
CanSwapRow(AFromRow, AToRow: Integer): Boolean Checks if rows can be swapped.
ClearCells(ACellRange: TTMSFNCDataGridCellCoordRange); virtual Clears cells within a range.
ClearData Clears all data in the grid.
ClearFilter Clears the current filter.
ClearFind Clears the find results.
ClearNodeRow(ARow: Integer) Clears a node row.
CollapseAllNodes Collapses all nodes.
CollapseNode(ARow: Integer) Collapses a specific node.
ColumnAverage(AColumn: Integer; AFromRow: Integer = -1; AToRow: Integer = -1): Double Calculates the average of a column.
ColumnCalculation(AColumn: Integer; AMethod: TTMSFNCDataGridDataCalculationMethod; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil; ACustomCalculationCallback: TTMSFNCDataGridDataCustomColumnCalculationCallback = nil); overload Performs a calculation on a column.
ColumnCalculation(AColumns: TArray; AMethod: TTMSFNCDataGridDataCalculationMethod; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil; ACustomCalculationCallback: TTMSFNCDataGridDataCustomColumnCalculationCallback = nil); overload Performs calculations on multiple columns.
ColumnCounting(AColumn: Integer; AFromRow: Integer = -1; AToRow: Integer = -1): Double Counts the number of items in a column.
ColumnCustomCalculation(AColumn: Integer; ACustomCalculationCallback: TTMSFNCDataGridDataCustomColumnCalculationCallback = nil; AFromRow: Integer = -1; AToRow: Integer = -1): Double Performs a custom calculation on a column.
ColumnDistinct(AColumn: Integer; AFromRow: Integer = -1; AToRow: Integer = -1): Double Gets the distinct values in a column.
ColumnMax(AColumn: Integer; AFromRow: Integer = -1; AToRow: Integer = -1): Double Finds the maximum value in a column.
ColumnMin(AColumn: Integer; AFromRow: Integer = -1; AToRow: Integer = -1): Double Finds the minimum value in a column.
ColumnSpan(ACell: TTMSFNCDataGridCellCoord): Integer Gets the span of a column.
ColumnStandardDeviation(AColumn: Integer; AFromRow: Integer = -1; AToRow: Integer = -1): Double Calculates the standard deviation of a column.
ColumnSum(AColumn: Integer; AFromRow: Integer = -1; AToRow: Integer = -1): Double Sums the values in a column.
DeleteColumn(AColumn: Integer) Deletes a column.
DeleteColumns(AColumn, ACount: Integer) Deletes multiple columns.
DeleteRow(ARow: Integer) Deletes a row.
DeleteRows(ARow, ACount: Integer); virtual Deletes multiple rows.
Destructor Destroy; override Destructor for the grid.
EndUpdate Ends updating the grid.
ExpandAllNodes Expands all nodes.
ExpandNode(ARow: Integer) Expands a specific node.
Find(AText: string): TTMSFNCDataGridCellCoord; overload Finds text in the grid.
Find(AText: string; AParameters: TTMSFNCDataGridDataFindParameters): TTMSFNCDataGridCellCoord; overload Finds text with parameters.
Find(AText: string; AParameters: TTMSFNCDataGridDataFindParameters; AStartCell: TTMSFNCDataGridCellCoord): TTMSFNCDataGridCellCoord; overload Finds text with parameters starting from a cell.
FindAll(AText: string; AParameters: TTMSFNCDataGridDataFindParameters; var AResults: Integer): TTMSFNCDataGridCellCoord Finds all occurrences of text.
FindFirst(AText: string; AParameters: TTMSFNCDataGridDataFindParameters): TTMSFNCDataGridCellCoord Finds the first occurrence of text.
FindNext(ADown: Boolean): TTMSFNCDataGridCellCoord; overload Finds the next occurrence of text in a direction.
FindNext: TTMSFNCDataGridCellCoord; overload Finds the next occurrence of text.
GetCellKind(ACell: TTMSFNCDataGridCellCoord): TTMSFNCDataGridCellKind Gets the kind of a cell.
GetCellMergeType(ACell: TTMSFNCDataGridCellCoord): TTMSFNCDataGridDataCellMergeType Gets the merge type of a cell.
GetCellSize(ACell: TTMSFNCDataGridCellCoord): TSizeF Gets the size of a cell.
GetMaxLevel Gets the maximum level of rows.
GetParentRow(ARow: Integer): Integer Gets the parent row of a row.
GetRootRow(ARow: Integer): Integer Gets the root row of a row.
GoToCell(ACell: TTMSFNCDataGridCellCoord; ASelect: Boolean = True); virtual Navigates to a specific cell.
Group(AColumn: Integer); overload Groups by a column.
Group(AColumns: TArray; ASortColumns: TArray = nil; ACustomGroupCallback: TTMSFNCDataGridDataGetCustomGroupCallback = nil; ACustomCompareCallback: TTMSFNCDataGridDataCustomCompareCallback = nil; AGroupOptionsCallback: TTMSFNCDataGridDataGetGroupOptionsCallback = nil; ASortOptionsCallback: TTMSFNCDataGridDataGetSortOptionsCallback = nil); overload Groups by multiple columns.
Group(AGroupInfo: TTMSFNCDataGridDataGroupInfo; ACustomGroupCallback: TTMSFNCDataGridDataGetCustomGroupCallback = nil; ACustomCompareCallback: TTMSFNCDataGridDataCustomCompareCallback = nil; AGroupOptionsCallback: TTMSFNCDataGridDataGetGroupOptionsCallback = nil; ASortOptionsCallback: TTMSFNCDataGridDataGetSortOptionsCallback = nil); overload Groups by group info.
GroupAverage(AColumn: Integer; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Calculates the average for a group.
GroupAverage(AColumns: TArray; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Calculates averages for multiple groups.
GroupCalculation(AColumn: Integer; AMethod: TTMSFNCDataGridDataCalculationMethod; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil; ACustomCalculationCallback: TTMSFNCDataGridDataCustomColumnCalculationCallback = nil); overload Performs a calculation for a group.
GroupCalculation(AColumns: TArray; AMethod: TTMSFNCDataGridDataCalculationMethod; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil; ACustomCalculationCallback: TTMSFNCDataGridDataCustomColumnCalculationCallback = nil); overload Performs calculations for multiple groups.
GroupCount(AColumn: Integer; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Counts items in a group.
GroupCount(AColumns: TArray; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Counts items in multiple groups.
GroupCustomCalculation(AColumn: Integer; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil; ACustomCalculationCallback: TTMSFNCDataGridDataCustomColumnCalculationCallback = nil); overload Performs a custom calculation for a group.
GroupCustomCalculation(AColumns: TArray; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil; ACustomCalculationCallback: TTMSFNCDataGridDataCustomColumnCalculationCallback = nil); overload Performs custom calculations for multiple groups.
GroupDistinct(AColumn: Integer; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Gets distinct values for a group.
GroupDistinct(AColumns: TArray; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Gets distinct values for multiple groups.
GroupMax(AColumn: Integer; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Finds the maximum value for a group.
GroupMax(AColumns: TArray; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Finds the maximum values for multiple groups.
GroupMin(AColumn: Integer; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Finds the minimum value for a group.
GroupMin(AColumns: TArray; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Finds the minimum values for multiple groups.
GroupSort(AColumn: Integer; ADirection: TTMSFNCDataGridSortDirection); overload Sorts a group by a column.
GroupSort(AColumns: TArray; ADirections: TArray; ACustomCompareCallback: TTMSFNCDataGridDataCustomCompareCallback = nil; ASortOptionsCallback: TTMSFNCDataGridDataGetSortOptionsCallback = nil); reintroduce; overload Sorts groups by multiple columns.
GroupSortIndexed Sorts groups by index.
GroupStandardDeviation(AColumn: Integer; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Calculates the standard deviation for a group.
GroupStandardDeviation(AColumns: TArray; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Calculates standard deviations for multiple groups.
GroupSum(AColumn: Integer; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Sums values for a group.
GroupSum(AColumns: TArray; ACalculationOptionsCallback: TTMSFNCDataGridDataGetColumnCalculationOptionsCallback = nil); overload Sums values for multiple groups.
HasRowData(ARow: Integer): Boolean Checks if a row has data.
InsertColumn(AColumn: Integer) Inserts a column.
InsertColumns(AColumn, ACount: Integer) Inserts multiple columns.
InsertRow(ARow: Integer) Inserts a row.
InsertRows(ARow, ACount: Integer); virtual Inserts multiple rows.
IsCellBase(ACell: TTMSFNCDataGridCellCoord): Boolean Checks if a cell is a base cell.
IsCellHidden(ACell: TTMSFNCDataGridCellCoord): Boolean Checks if a cell is hidden.
IsCellMerged(ACell: TTMSFNCDataGridCellCoord): Boolean Checks if a cell is merged.
IsCellVisible(ACell: TTMSFNCDataGridCellCoord): Boolean; override Checks if a cell is visible.
IsGrouped Checks if the grid is grouped.
IsRowBand(ARow: Integer): Boolean Checks if a row is a band.
IsRowNode(ARow: Integer): Boolean Checks if a row is a node.
IsRowNormal(ARow: Integer): Boolean Checks if a row is normal.
IsRowSummary(ARow: Integer): Boolean Checks if a row is a summary.
LinearFill(ADoFixed: Boolean = False) Fills the grid linearly.
LoadFromCSVData(AFileName: string); overload; virtual Loads data from a CSV file.
LoadFromCSVData(AFileName: string; AEncoding: TEncoding); overload; virtual Loads data from a CSV file with encoding.
LoadFromCSVStreamData(AStream: TStream); overload; virtual Loads data from a CSV stream.
LoadFromCSVStreamData(AStream: TStream; AEncoding: TEncoding); overload; virtual Loads data from a CSV stream with encoding.
LoadFromFileData(AFileName: string); overload; virtual Loads data from a file.
LoadFromFileData(AFileName: string; AEncoding: TEncoding); overload; virtual Loads data from a file with encoding.
LoadFromFileStreamData(AStream: TStream); overload; virtual Loads data from a file stream.
LoadFromFileStreamData(AStream: TStream; AEncoding: TEncoding); overload; virtual Loads data from a file stream with encoding.
LoadFromJSONData(AFileName: string; AEncoding: TEncoding; ARowDataName: string = ''; AColumnDataName: string = ''; AColumnNames: TTMSFNCDataGridDataJSONNamesArray = nil); overload; virtual Loads data from a JSON file with encoding.
LoadFromJSONData(AFileName: string; ARowDataName: string = ''; AColumnDataName: string = ''; AColumnNames: TTMSFNCDataGridDataJSONNamesArray = nil); overload; virtual Loads data from a JSON file.
LoadFromJSONStreamData(AStream: TStream; AEncoding: TEncoding; ARowDataName: string = ''; AColumnDataName: string = ''; AColumnNames: TTMSFNCDataGridDataJSONNamesArray = nil ); overload; virtual Loads data from a JSON stream with encoding.
LoadFromJSONStreamData(AStream: TStream; ARowDataName: string = ''; AColumnDataName: string = ''; AColumnNames: TTMSFNCDataGridDataJSONNamesArray = nil ); overload; virtual Loads data from a JSON stream.
LoadFromJSONTextData(AText: string; ARowDataName: string = ''; AColumnDataName: string = ''; AColumnNames: TTMSFNCDataGridDataJSONNamesArray = nil ); virtual Loads data from JSON text.
LoadFromXMLData(AFileName: string); overload; virtual Loads data from an XML file.
LoadFromXMLData(AFileName: string; AEncoding: TEncoding); overload; virtual Loads data from an XML file with encoding.
LoadFromXMLStreamData(AStream: TStream); overload; virtual Loads data from an XML stream.
LoadFromXMLStreamData(AStream: TStream; AEncoding: TEncoding); overload; virtual Loads data from an XML stream with encoding.
LoadSampleData Loads sample data.
MatchFilter(ARow: Integer): Boolean; virtual Checks if a row matches the filter.
MergeCells(AColumn, ARow, AColumnCount, ARowCount: Integer) Merges cells.
MergeColumn(AColumn: Integer) Merges a column.
MergeColumns(AColumn, ACount: Integer) Merges multiple columns.
MergeRange(ARange: TTMSFNCDataGridCellCoordRange) Merges a range of cells.
MergeRow(ARow: Integer) Merges a row.
MergeRows(ARow, ACount: Integer) Merges multiple rows.
MoveColumn(AFromColumn, AToColumn: Integer) Moves a column.
MoveRow(AFromRow, AToRow: Integer) Moves a row.
RandomFill(ADoFixed: Boolean = False; ARandomNumber: Integer = 100) Fills the grid randomly.
RefreshData(ACell: TTMSFNCDataGridCellCoord; AUpdate: Boolean = True); overload; virtual Refreshes data for a cell.
RefreshData(ACellRange: TTMSFNCDataGridCellCoordRange; AUpdate: Boolean = True); overload; virtual Refreshes data for a range of cells.
RefreshData(AUpdate: Boolean = True); overload; virtual Refreshes all data.
RemoveFilter Removes the current filter.
RemoveNodeRow(ARow: Integer) Removes a node row.
Replace(AOriginalValue, ANewValue: string): Integer; overload Replaces text in the grid.
Replace(AOriginalValue, ANewValue: string; AParameters: TTMSFNCDataGridDataFindParameters): Integer; overload Replaces text with parameters.
RowAverage(ARow: Integer; AFromColumn: Integer = -1; AToColumn: Integer = -1): Double Calculates the average of a row.
RowCalculation(ARow: Integer; AMethod: TTMSFNCDataGridDataCalculationMethod; ACalculationOptionsCallback: TTMSFNCDataGridDataGetRowCalculationOptionsCallback = nil; ACustomCalculationCallback: TTMSFNCDataGridDataCustomRowCalculationCallback = nil); overload Performs a calculation on a row.
RowCalculation(ARows: TArray; AMethod: TTMSFNCDataGridDataCalculationMethod; ACalculationOptionsCallback: TTMSFNCDataGridDataGetRowCalculationOptionsCallback = nil; ACustomCalculationCallback: TTMSFNCDataGridDataCustomRowCalculationCallback = nil); overload Performs calculations on multiple rows.
RowCounting(ARow: Integer; AFromColumn: Integer = -1; AToColumn: Integer = -1): Double Counts the number of items in a row.
RowCustomCalculation(ARow: Integer; ACustomCalculationCallback: TTMSFNCDataGridDataCustomRowCalculationCallback = nil; AFromColumn: Integer = -1; AToColumn: Integer = -1): Double Performs a custom calculation on a row.
RowDistinct(ARow: Integer; AFromColumn: Integer = -1; AToColumn: Integer = -1): Double Gets the distinct values in a row.
RowMax(ARow: Integer; AFromColumn: Integer = -1; AToColumn: Integer = -1): Double Finds the maximum value in a row.
RowMin(ARow: Integer; AFromColumn: Integer = -1; AToColumn: Integer = -1): Double Finds the minimum value in a row.
RowSpan(ACell: TTMSFNCDataGridCellCoord): Integer Gets the span of a row.
RowStandardDeviation(ARow: Integer; AFromColumn: Integer = -1; AToColumn: Integer = -1): Double Calculates the standard deviation of a row.
RowSum(ARow: Integer; AFromColumn: Integer = -1; AToColumn: Integer = -1): Double Sums the values in a row.
SaveToCSVData(AFileName: string); overload; virtual Saves data to a CSV file.
SaveToCSVData(AFileName: string; AEncoding: TEncoding); overload; virtual Saves data to a CSV file with encoding.
SaveToCSVStreamData(AStream: TStream); overload; virtual Saves data to a CSV stream.
SaveToCSVStreamData(AStream: TStream; AEncoding: TEncoding); overload; virtual Saves data to a CSV stream with encoding.
SaveToFileData(AFileName: string); overload; virtual Saves data to a file.
SaveToFileData(AFileName: string; AEncoding: TEncoding); overload; virtual Saves data to a file with encoding.
SaveToFileStreamData(AStream: TStream); overload; virtual Saves data to a file stream.
SaveToFileStreamData(AStream: TStream; AEncoding: TEncoding); overload; virtual Saves data to a file stream with encoding.
SetNodeRow(ARow: Integer; AChildCount: Integer; ALevel: Integer = 0; AMerge: Boolean = True) Sets a node row.
Sort(AColumn: Integer; ADirection: TTMSFNCDataGridSortDirection); reintroduce; overload Sorts a column.
Sort(AColumn: Integer; ADirection: TTMSFNCDataGridSortDirection; AFromRow, AToRow: Integer); reintroduce; overload Sorts a column within a range.
Sort(AColumns: TArray; ADirections: TArray; ACustomCompareCallback: TTMSFNCDataGridDataCustomCompareCallback = nil; ASortOptionsCallback: TTMSFNCDataGridDataGetSortOptionsCallback = nil); reintroduce; overload Sorts multiple columns.
Sort(AColumns: TArray; ADirections: TArray; AFromRow, AToRow: Integer; ACustomCompareCallback: TTMSFNCDataGridDataCustomCompareCallback = nil; ASortOptionsCallback: TTMSFNCDataGridDataGetSortOptionsCallback = nil); reintroduce; overload Sorts multiple columns within a range.
SortIndexed Sorts by index.
SplitCell(ACell: TTMSFNCDataGridCellCoord) Splits a cell.
SwapCells(AFromCell, AToCell: TTMSFNCDataGridCellCoord) Swaps cells.
SwapColumn(AFromColumn, AToColumn: Integer) Swaps columns.
SwapRow(AFromRow, AToRow: Integer) Swaps rows.
ToggleNode(ARow: Integer) Toggles a node.
Ungroup Ungroups the grid.
UpdateCalculations Updates all calculations.
UpdateColumnCalculation(AColumn: Integer; AName: string) Updates a column calculation.
UpdateColumnCalculations Updates all column calculations.
UpdateRowCalculation(ARow: Integer; AName: string) Updates a row calculation.
UpdateRowCalculations Updates all row calculations.