Skip to main content
A newer version of this page is available. .

TcxGridDataController Members

A data controller.

Properties

Name Description
Active Inherited from TcxCustomDataController.
CustomDataSource Identifies the user-defined data source. Inherited from TcxCustomDataController.
DataControllerInfo Inherited from TcxCustomDataController.
DataRowCount Returns the number of data rows in the data controller. Inherited from TcxCustomDataController.
DetailMode Inherited from TcxCustomDataController.
DisplayTexts Determines the text representation of the value in an item at a specific record. Inherited from TcxCustomDataController.
EditingRecordIndex Inherited from TcxCustomDataController.
EditOperations Specifies a set of operations to perform on records in a data controller. Inherited from TcxCustomDataController.
EditState Specifies the edit state of a data controller. Inherited from TcxCustomDataController.
ErrorCodes Returns an expression error code by the specified record and item indexes. Inherited from TcxCustomDataController.
Filter Defines a set of filter conditions applied to data. Inherited from TcxCustomDataController.
FilteredIndexByRecordIndex Returns the position of a data record in the list of filtered records. Inherited from TcxCustomDataController.
FilteredRecordCount Specifies the number of data records in a data controller after applying filter criteria. Inherited from TcxCustomDataController.
FilteredRecordIndex Returns the record index of a filtered record. Inherited from TcxCustomDataController.
FindCriteria Provides access to appearance and behavior settings of the associated container control’s Find Panel. Inherited from TcxCustomDataController.
FixedBottomRowCount Inherited from TcxCustomDataController.
FixedTopRowCount Inherited from TcxCustomDataController.
FocusedDataRowIndex Inherited from TcxCustomDataController.
FocusedRecordIndex Specifies the record index of the record with the current focus. Inherited from TcxCustomDataController.
FocusedRowIndex Specifies the row index of the record with focus. Inherited from TcxCustomDataController.
GridView Provides access to the View whose data is managed by the data controller.
Groups Provides access to data groups in a grid control. Inherited from TcxCustomDataController.
HasRelations Inherited from TcxCustomDataController.
IsBrowsing Inherited from TcxCustomDataController.
IsCancelling Inherited from TcxCustomDataController.
IsCreatingLinkObject Inherited from TcxCustomDataController.
IsDetailExpanding Inherited from TcxCustomDataController.
IsEditing Specifies whether a data controller is in edit mode. Inherited from TcxCustomDataController.
IsPattern Indicates whether the current detail data controller is a pattern, as defined below. Inherited from TcxCustomDataController.
IsProviderMode Inherited from TcxCustomDataController.
IsRowInfoValid Inherited from TcxCustomDataController.
IsUpdatingItems Inherited from TcxCustomDataController.
ItemCount Inherited from TcxCustomDataController.
ItemExpressions Specifies calculated field expressions for data items by their indexes. Inherited from TcxCustomDataController.
LockCount Inherited from TcxCustomDataController.
LockGridModeNotifyCount Inherited from TcxCustomDataController.
MultiSelect Enables selection of multiple records in a data controller. Inherited from TcxCustomDataController.
MultiThreadedOptions Provides access to a data controller’s multi-threaded data processing settings. Inherited from TcxCustomDataController.
NewItemRecordIndex Inherited from TcxCustomDataController.
NewItemRowFocused Inherited from TcxCustomDataController.
Options Defines the set of options affecting the behavior of a data controller. Inherited from TcxCustomDataController.
RecordCount Defines the number of records provided by the data controller. Inherited from TcxCustomDataController.
Relations Inherited from TcxCustomDataController.
RowCount Returns the number of rows in a data controller. Inherited from TcxCustomDataController.
RowFixedState Inherited from TcxCustomDataController.
Search Provides access to the object enabling you to perform incremental searching programmatically. Inherited from TcxCustomDataController.
SortingBySummaryDataItemIndex Inherited from TcxCustomDataController.
Summary Specifies the set of summaries calculated by grid data. Inherited from TcxCustomDataController.
UseNewItemRowForEditing This property is for internal use only. You will have no need to use it in applications. Inherited from TcxCustomDataController.
Values Determines the value of a specific record and item. Inherited from TcxCustomDataController.

Methods

Name Description
AddDataChangedListener(TObject,TNotifyEvent) Inherited from TcxCustomDataController.
AddDataChangeRefCount Inherited from TcxCustomDataController.
AddItem(TObject) Inherited from TcxCustomDataController.
Append Appends a new record to the underlying dataset. Inherited from TcxCustomDataController.
AppendRecord Appends a new record to a data controller. Inherited from TcxCustomDataController.
AreAllRowsSelected Indicates if all rows the data controller displays are selected. Inherited from TcxCustomDataController.
Assign(TPersistent) Inherited from TPersistent.
AssignTo(TPersistent) Inherited from TPersistent.
BeginFullUpdate Prevents update notifications in the data controller and the object that displays its data until the EndFullUpdate method call. Inherited from TcxCustomDataController.
BeginUpdate Postpones sending update notifications by the data controller. Inherited from TcxCustomDataController.
BeginUpdateFields Locks field update notifications until the EndUpdateFields method is called. Inherited from TcxCustomDataController.
Cancel Cancels unposted record modifications. Inherited from TcxCustomDataController.
CanInitEditing(Integer) Inherited from TcxCustomDataController.
ChangeDetailActiveRelationIndex(Integer,Integer) Inherited from TcxCustomDataController.
ChangeDetailExpanding(Integer,Boolean) Expands or collapses a master record. Inherited from TcxCustomDataController.
ChangeFocusedRecordIndex(Integer) Inherited from TcxCustomDataController.
ChangeFocusedRowIndex(Integer) Inherited from TcxCustomDataController.
ChangeIncrementalFilterText(string) Inherited from TcxCustomDataController.
ChangeItemSortingIndex(Integer,Integer) Inherited from TcxCustomDataController.
ChangeNeedConversion(Integer,Boolean) Inherited from TcxCustomDataController.
ChangeRowSelection(Integer,Boolean) Changes the selection state of a particular row. Inherited from TcxCustomDataController.
ChangeSorting(Integer,TcxDataSortOrder) Inherited from TcxCustomDataController.
ChangeTextStored(Integer,Boolean) Inherited from TcxCustomDataController.
ChangeValueTypeClass(Integer,TcxValueTypeClass) Inherited from TcxCustomDataController.
CheckBrowseMode Inherited from TcxCustomDataController.
CheckDetailsBrowseMode protected Inherited from TcxCustomDataController.
CheckFocusedRow Inherited from TcxCustomDataController.
CheckFocusedSelected When selection of multiple records is enabled, this method selects the focused record. Inherited from TcxCustomDataController.
ClearBookmark Removes the current bookmark. Inherited from TcxCustomDataController.
ClearDetailLinkObject(Integer,Integer) Recreates a particular detail clone. Inherited from TcxCustomDataController.
ClearDetails Recreates existing clones of detail data controllers associated with the current master data controller. Inherited from TcxCustomDataController.
ClearSelection Unselects all rows in a data controller. Inherited from TcxCustomDataController.
ClearSelectionAnchor Inherited from TcxCustomDataController.
ClearSorting(Boolean) Clears sorting applied to the data controller’s items. Inherited from TcxCustomDataController.
CollapseDetails Collapses details of the current master data controller. Inherited from TcxCustomDataController.
CreateDetailLinkObject(TcxCustomDataRelation,Integer) Inherited from TcxCustomDataController.
CreateFilter Inherited from TcxCustomDataController.
DataChangedNotifyLocked Inherited from TcxCustomDataController.
DeleteFocused Deletes the focused row in a data controller. Inherited from TcxCustomDataController.
DeleteRecord(Integer) Deletes a data record referenced by a record index (in unbound or provider mode only). Inherited from TcxCustomDataController.
DeleteSelection Deletes selected rows from a data controller. Inherited from TcxCustomDataController.
Edit Activates edit mode for the focused record. Inherited from TcxCustomDataController.
EndFullUpdate Unlocks the data controller and its associated visual object after the BeginFullUpdate method call. Inherited from TcxCustomDataController.
EndUpdate Re-enables sending update notifications by the data controller after they were suspended by calling BeginUpdate. Inherited from TcxCustomDataController.
EndUpdateFields Re-enables field update notifications after the BeginUpdateFields method call. Inherited from TcxCustomDataController.
Equals(TObject) Inherited from TObject.
ExecuteAction(TBasicAction) Inherited from TcxCustomDataController.
FindRecordIndexByText(Integer,Integer,string,Boolean,Boolean,Boolean,Boolean) Inherited from TcxCustomDataController.
FindRecordIndexByText(Integer,Integer,string,Boolean,Boolean,Boolean) Returns the record index of the record matching the supplied text within a particular field. Inherited from TcxCustomDataController.
FocusControl(Integer,Boolean) Inherited from TcxCustomDataController.
FocusDetails(Integer) Recursively focuses records in all the active details which correspond to the specified master record. Inherited from TcxCustomDataController.
FocusSelectedRow(Integer) Inherited from TcxCustomDataController.
ForEachDetail(TcxCustomDataRelation,TcxDataControllerEachDetailProc) Inherited from TcxCustomDataController.
ForEachRow(Boolean,TcxDataControllerEachRowProc) Calls a custom procedure for each row in a data controller. Inherited from TcxCustomDataController.
GetAllowedSummaryKinds(TcxCustomDataField) Inherited from TcxCustomDataController.
GetAllowedSummaryKinds(TcxValueTypeClass) Inherited from TcxCustomDataController.
GetAllowedSummaryKinds(Integer) Inherited from TcxCustomDataController.
GetDetailActiveRelationIndex(Integer) Inherited from TcxCustomDataController.
GetDetailDataController(Integer,Integer) Returns a clone of the detail data controller associated with a specific record in the current master data controller. Inherited from TcxCustomDataController.
GetDetailDataControllerByLinkObject(TObject) Inherited from TcxCustomDataController.
GetDetailExpanding(Integer) Inherited from TcxCustomDataController.
GetDetailHasChildren(Integer,Integer) Inherited from TcxCustomDataController.
GetDetailLinkObject(Integer,Integer) Inherited from TcxCustomDataController.
GetDisplayText(Integer,Integer) Inherited from TcxCustomDataController.
GetEditingRecordIndex Inherited from TcxCustomDataController.
GetEditValue(Integer,TcxDataEditValueSource) Inherited from TcxCustomDataController.
GetFilterDataValue(Integer,TcxCustomDataField) Inherited from TcxCustomDataController.
GetFilterItemFieldCaption(TObject) Inherited from TcxCustomDataController.
GetFilterItemFieldName(TObject) Inherited from TcxCustomDataController.
GetFocusedRecordIndex Inherited from TcxCustomDataController.
GetFocusedRowIndex Inherited from TcxCustomDataController.
GetGroupRowDisplayText(TcxRowInfo,Integer) Inherited from TcxCustomDataController.
GetGroupRowValue(TcxRowInfo,Integer) Inherited from TcxCustomDataController.
GetGroupValue(Integer,TcxCustomDataField) Inherited from TcxCustomDataController.
GetGroupValues(Integer,TcxDataSummaryValues) Inherited from TcxCustomDataController.
GetHashCode Inherited from TObject.
GetIncrementalFilterField Inherited from TcxCustomDataController.
GetIncrementalFilterText Inherited from TcxCustomDataController.
GetItem(Integer) Inherited from TcxCustomDataController.
GetItemCount Inherited from TcxCustomDataController.
GetItemID(TObject) protected Inherited from TcxCustomDataController.
GetItemNeedConversion(Integer) Inherited from TcxCustomDataController.
GetItemSortByDisplayText(Integer,Boolean) Inherited from TcxCustomDataController.
GetItemSortingIndex(Integer) Inherited from TcxCustomDataController.
GetItemSortOrder(Integer) Inherited from TcxCustomDataController.
GetItemTextStored(Integer) Inherited from TcxCustomDataController.
GetItemValueSource(Integer) Inherited from TcxCustomDataController.
GetItemValueTypeClass(Integer) Inherited from TcxCustomDataController.
GetMasterDataController Returns the master data controller for the current detail data controller. Inherited from TcxCustomDataController.
GetMasterRecordIndex Returns the record index of the master record corresponding to the current clone of a detail data controller. Inherited from TcxCustomDataController.
GetMasterRelation Inherited from TcxCustomDataController.
GetNamePath Inherited from TPersistent.
GetNearestRowIndex(Integer) Inherited from TcxCustomDataController.
GetNewItemRecordIndex Inherited from TcxCustomDataController.
GetOwner Inherited from TPersistent.
GetPatternDataController Returns a pattern data controller for a detail data controller. Inherited from TcxCustomDataController.
GetRecordCount Inherited from TcxCustomDataController.
GetRecordId(Integer) Inherited from TcxCustomDataController.
GetRootDataController Inherited from TcxCustomDataController.
GetRowCount Inherited from TcxCustomDataController.
GetRowDisplayText(TcxRowInfo,Integer) Returns the display text for an item of a specific row. Inherited from TcxCustomDataController.
GetRowId(Integer) Inherited from TcxCustomDataController.
GetRowIndexByRecordIndex(Integer,Boolean) Returns the position of a data record in a data controller by its record index. Inherited from TcxCustomDataController.
GetRowInfo(Integer) Returns an object containing information on a particular row. Inherited from TcxCustomDataController.
GetRowValue(TcxRowInfo,Integer) Obtains the value for a particular row/item. Inherited from TcxCustomDataController.
GetSelectedCount Returns the number of selected rows. Inherited from TcxCustomDataController.
GetSelectedRowIndex(Integer) Returns the row index of a selected row. Inherited from TcxCustomDataController.
GetSelectionAnchorRowIndex Inherited from TcxCustomDataController.
GetSortingItemCount Inherited from TcxCustomDataController.
GetSortingItemIndex(Integer) Inherited from TcxCustomDataController.
GetValue(Integer,Integer) Inherited from TcxCustomDataController.
GotoBookmark Locates the record referred to by the current bookmark. Inherited from TcxCustomDataController.
GotoFirst Moves focus to the first visible row. Inherited from TcxCustomDataController.
GotoLast Moves focus to the last visible row. Inherited from TcxCustomDataController.
GotoNext Moves focus to the next visible row. Inherited from TcxCustomDataController.
GotoPrev Moves focus to the previous visible row within a data controller. Inherited from TcxCustomDataController.
GroupContainsSelectedRows(Integer) Indicates if any of a specified row’s child rows are selected. Inherited from TcxCustomDataController.
HasIncrementalFilter Inherited from TcxCustomDataController.
Insert Inserts a new record in a data controller. Inherited from TcxCustomDataController.
InsertRecord(Integer) Inserts a new empty record in the current data controller. Inherited from TcxCustomDataController.
IsBOF Returns a value indicating whether the first visible row is focused. Inherited from TcxCustomDataController.
IsBookmarkAvailable Indicates whether there is a bookmark available (created by the SaveBookmark method). Inherited from TcxCustomDataController.
IsBookmarkRow(Integer) Inherited from TcxCustomDataController.
IsDataLoading Inherited from TcxCustomDataController.
IsDetailDataControllerExist(Integer,Integer) Inherited from TcxCustomDataController.
IsDetailMode Returns a value indicating whether the current data controller is a detail of another data controller. Inherited from TcxCustomDataController.
IsDisplayFormatDefined(Integer,Boolean) Inherited from TcxCustomDataController.
IsEOF Returns a value indicating whether the last visible row is focused. Inherited from TcxCustomDataController.
IsGridMode Indicates whether your data controller is working in grid mode. Inherited from TcxCustomDataController.
IsImmediatePost Inherited from TcxCustomDataController.
IsItemExpression(Integer) Identifies if the specified data item corresponds to a calculated column or row in a container control. Inherited from TcxCustomDataController.
IsRowSelected(Integer) Returns a value indicating whether a particular row is selected. Inherited from TcxCustomDataController.
IsSelectionAnchorExist Inherited from TcxCustomDataController.
ItemPropertiesChanged(Integer) Inherited from TcxCustomDataController.
Loaded Inherited from TcxCustomDataController.
LoadFromStream(TStream) Populates your data controller with data from a stream. Inherited from TcxCustomDataController.
LockDataChangedNotify Inherited from TcxCustomDataController.
LockGridModeNotify Inherited from TcxCustomDataController.
MakeRecordVisible(Integer) Makes a record potentially visible by expanding the data group owning it. Inherited from TcxCustomDataController.
MoveBy(Integer) Inherited from TcxCustomDataController.
MultiSelectionSyncGroupWithChildren Indicates if group rows synchronize their selected state with child rows. Inherited from TcxCustomDataController.
Post(Boolean) Posts a record to a data source. Inherited from TcxCustomDataController.
PostEditingData Posts edited data to a data source. Inherited from TcxCustomDataController.
Refresh Inherited from TcxCustomDataController.
RefreshExternalData Forces a data controller to reload data from a data source. Inherited from TcxCustomDataController.
RemoveDataChangedListener(TObject,TNotifyEvent) Inherited from TcxCustomDataController.
RemoveDataChangeRefCount Inherited from TcxCustomDataController.
RemoveItem(TObject) Inherited from TcxCustomDataController.
ResetHasChildrenFlag Inherited from TcxCustomDataController.
ResetIncrementalFilter Inherited from TcxCustomDataController.
ResetRelationByItem(TObject) Inherited from TcxCustomDataController.
RestoreDataSetPos Inherited from TcxCustomDataController.
RestoreKeys Restores the record identifiers of the expanded master rows, grouping rows and selected rows. Inherited from TcxCustomDataController.
SaveBookmark Saves the focused record as a bookmark. Inherited from TcxCustomDataController.
SaveDataSetPos Inherited from TcxCustomDataController.
SaveKeys Saves the record identifiers of the expanded master rows, grouping rows and selected rows. Inherited from TcxCustomDataController.
SaveToStream(TStream) Saves data provided by the current data controller to a stream. Inherited from TcxCustomDataController.
Scroll(Integer) Inherited from TcxCustomDataController.
SelectAll Selects all potentially visible rows in the current data controller. Inherited from TcxCustomDataController.
SelectFromAnchor(Integer,Boolean) Inherited from TcxCustomDataController.
SelectRows(Integer,Integer) Selects a continuous range of rows. Inherited from TcxCustomDataController.
SetDisplayText(Integer,Integer,string) Inherited from TcxCustomDataController.
SetEditValue(Integer,Variant,TcxDataEditValueSource) Sets the value of a specific item in the record currently being edited. Inherited from TcxCustomDataController.
SetFocus Inherited from TcxCustomDataController.
SetIncrementalFilter(Integer,string,Boolean) Inherited from TcxCustomDataController.
SetIncrementalFilter(Integer,string) Inherited from TcxCustomDataController.
SetMasterMode(TcxCustomDataRelation,Boolean) Inherited from TcxCustomDataController.
SetMasterRelation(TcxCustomDataRelation,Integer) Inherited from TcxCustomDataController.
SetRecordCount(Integer) Inherited from TcxCustomDataController.
SetSelectionAnchor(Integer) Inherited from TcxCustomDataController.
SetValue(Integer,Integer,Variant) Sets record values within a data controller. Inherited from TcxCustomDataController.
SortByDisplayTextChanged Inherited from TcxCustomDataController.
SyncSelected(Boolean) Allows you to select/unselect the focused row when multiple row selection is disabled. Inherited from TcxCustomDataController.
SyncSelectionFocusedRecord Inherited from TcxCustomDataController.
ToString Inherited from TObject.
UnlockDataChangedNotify Inherited from TcxCustomDataController.
UnlockGridModeNotify Inherited from TcxCustomDataController.
UpdateAction(TBasicAction) Inherited from TcxCustomDataController.
UpdateData Inherited from TcxCustomDataController.
UpdateFields protected Inherited from TcxCustomDataController.
UpdateItemIndexes Inherited from TcxCustomDataController.
UpdateItems(Boolean) Forces the current data controller to recreate items, and reload their values based on the bound data source. Inherited from TcxCustomDataController.

Events

Name Description
OnAfterCancel Occurs after canceling the modifications to the active record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnAfterDelete Allows you to perform specific actions after the data controller deletes a record. Inherited from TcxCustomDataController.
OnAfterInsert Occurs after inserting a new record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnAfterPost Occurs after saving changes made to a record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnBeforeCancel Occurs before canceling modifications to the active record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnBeforeDelete Allows you to perform specific actions when the data controller is about to delete a record. Inherited from TcxCustomDataController.
OnBeforeImmediatePost Inherited from TcxCustomDataController.
OnBeforeInsert Occurs before inserting a new record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnBeforePost Occurs before saving changes made to the modified record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnCanSelectRecord Inherited from TcxCustomDataController.
OnCompare Occurs when sorting records within a grid control. Inherited from TcxCustomDataController.
OnDataChanged Occurs on changing data provided by the data controller. Inherited from TcxCustomDataController.
OnDetailCollapsed Occurs after the details of a particular master record have been collapsed. Inherited from TcxCustomDataController.
OnDetailCollapsing Occurs when the details of a particular master record are about to be collapsed. Inherited from TcxCustomDataController.
OnDetailExpanded Occurs after the details of a particular master record have been expanded. Inherited from TcxCustomDataController.
OnDetailExpanding Occurs when the details of a particular master record are about to be expanded. Inherited from TcxCustomDataController.
OnFilterRecord Fires when the data controller is about to perform internal filtering. Inherited from TcxCustomDataController.
OnFindCriteriaBeforeChange Enables you to identify and track changes made to the data search criteria before they take effect on the data controller. Inherited from TcxCustomDataController.
OnFindCriteriaChanged Enables you to identify and track all data search criteria changes applied to the data controller. Inherited from TcxCustomDataController.
OnGroupingChanged Occurs after data grouping is changed. Inherited from TcxCustomDataController.
OnNewRecord Allows you to perform actions when the data controller is about to focus a new inserted record. Inherited from TcxCustomDataController.
OnRecordChanged Fires in response to data changes. Inherited from TcxCustomDataController.
OnSortingChanged Enables you to perform specific actions after data sorting has changed. Inherited from TcxCustomDataController.
OnUpdateControl Inherited from TcxCustomDataController.
See Also