Skip to main content
BuyLog In
VCL
Search in…
Docs > VCL Controls > ExpressDataController > API Reference > cxCustomData > TcxCustomDataController > Members
All docs
V23.2
VCL Controls
ExpressQuantumGrid Suite
ExpressEditors Library
ExpressBars Suite
ExpressCharts Suite
Express Cross Platform Library
ExpressRichEditControl Suite
ExpressSkins Library
ExpressScheduler Suite
ExpressSpreadSheet Suite
ExpressQuantumTreeList Suite
ExpressPDFViewer Suite
ExpressPrinting System
ExpressLayoutControl Suite
ExpressNavBar Suite
ExpressPivotGrid Suite
ExpressVerticalGrid Suite
ExpressDocking Library
ExpressMemData
ExpressDataController
Concepts
Provider Mode
Examples
API Reference
cxCustomData
EcxInvalidDataControllerOperation
PcxDataSelectionInfo
TcxAfterSummaryEvent
TcxCustomDataController
Members
Properties
Methods
Events
TcxCustomDataControllerInfo
TcxCustomDataField
TcxCustomDataFieldList
TcxCustomDataFindCriteria
TcxCustomDataProvider
TcxCustomDataRelation
TcxCustomDataRelationList
TcxCustomDataSource
TcxCustomDataSummaryItem
TcxDataControllerCompareEvent
TcxDataControllerComparisonMode
TcxDataControllerDetailMode
TcxDataControllerEachDetailProc
TcxDataControllerEachRowProc
TcxDataControllerEditKind
TcxDataControllerEditOperation
TcxDataControllerEditOperations
TcxDataControllerEditState
TcxDataControllerGroups
TcxDataControllerInfoHelper
TcxDataControllerMultiThreadedOptions
TcxDataControllerNotifyEvent
TcxDataControllerObject
TcxDataControllerOption
TcxDataControllerOptions
TcxDataControllerPersistent
TcxDataControllerRowFixedState
TcxDataControllerSearch
TcxDataDetailExpandedEvent
TcxDataDetailExpandingEvent
TcxDataFilterCriteria
TcxDataFilterCriteriaItem
TcxDataFilterGetValueListEvent
TcxDataFilterRecordEvent
TcxDataFilterValueList
TcxDataFindCriteria
TcxDataFindCriteriaBeforeChangeEvent
TcxDataFindCriteriaBehavior
TcxDataFindCriteriaChange
TcxDataFindCriteriaChangedEvent
TcxDataFindCriteriaChanges
TcxDataFooterSummaryItems
TcxDataGroupFieldInfo
TcxDataGroupIndex
TcxDataGroupInfo
TcxDataGroupInfoSummaryInfo
TcxDataGroupSummaryItems
TcxDataGroups
TcxDataItemHandle
TcxDataRecordAllowOperationEvent
TcxDataRecordChangedEvent
TcxDataRecordHandle
TcxDataRecordNotifyEvent
TcxDataSelection
TcxDataSelectionInfo
TcxDataSortFieldInfo
TcxDataSortOrder
TcxDataSummary
TcxDataSummaryGroup
TcxDataSummaryGroupItemLink
TcxDataSummaryGroupItemLinkClass
TcxDataSummaryGroupItemLinks
TcxDataSummaryGroups
TcxDataSummaryItem
TcxDataSummaryItemClass
TcxDataSummaryItemGetTextEvent
TcxDataSummaryItems
TcxDataSummaryValues
TcxDetailInfoObject
TcxDetailObject
TcxGroupingFieldList
TcxGroupsRowInfo
TcxNoParamsEvent
TcxRowInfo
TcxSortingBySummaryEngine
TcxSortingBySummaryEngineClass
TcxSortingFieldList
TcxSummaryEvent
TcxSummaryEventArguments
TcxSummaryEventOutArguments
TcxSummaryKind
TcxSummaryKinds
TcxSummaryOption
TcxSummaryOptions
TcxSummaryPosition
TcxSummaryValueType
TcxUpdateControlEvent
TcxUpdateControlInfo
dxDefaultMultiThreadedFiltering
dxDefaultMultiThreadedSorting
cxDB
cxDBData
cxData
cxDataStorage
cxDataUtils
cxFilter
cxVariants
dxCustomData
dxCustomFunction
dxServerModeADODataSource
dxServerModeClasses
dxServerModeDBXDataSource
dxServerModeData
dxServerModeFireDACDataSource
ExpressSpellChecker Suite
ExpressMapControl Suite
ExpressGanttControl Suite
ExpressGaugeControl Suite
ExpressTileControl Suite
ExpressFlowChart Suite
ExpressFlowChart Editor
ExpressOrgChart Suite
ExpressPageControl Suite
ExpressWizardControl Suite

TcxCustomDataController Members

The base class for all data controllers that manage data from different sources.

Properties

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

Methods

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

Events

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