Back to Devexpress

TcxDataController Members

vcl-cxdata-dot-tcxdatacontroller-dot-underscore-members.md

latest56.4 KB
Original Source

TcxDataController Members

The data controller which manages data from a data storage.

Properties

NameDescription
ActiveInherited from TcxCustomDataController.
CustomDataSourceIdentifies the user-defined data source. Inherited from TcxCustomDataController.
DataControllerInfoInherited from TcxCustomDataController.
DataRowCountReturns the number of data rows in the data controller. Inherited from TcxCustomDataController.
DetailModeInherited from TcxCustomDataController.
DisplayTextsDetermines the text representation of the value in an item at a specific record. Inherited from TcxCustomDataController.
EditingRecordIndexInherited from TcxCustomDataController.
EditOperationsSpecifies a set of operations to perform on records in a data controller. Inherited from TcxCustomDataController.
EditStateSpecifies the edit state of a data controller. Inherited from TcxCustomDataController.
ErrorCodesReturns an expression error code by the specified record and item indexes. Inherited from TcxCustomDataController.
FilterDefines a set of filter conditions applied to data. Inherited from TcxCustomDataController.
FilteredIndexByRecordIndexReturns the position of a data record in the list of filtered records. Inherited from TcxCustomDataController.
FilteredRecordCountReturns the number of records that meet the active filter criteria. Inherited from TcxCustomDataController.
FilteredRecordIndexReturns the record index of a filtered record. Inherited from TcxCustomDataController.
FindCriteriaProvides access to appearance and behavior settings of the associated container control’s Find Panel. Inherited from TcxCustomDataController.
FixedBottomRowCountInherited from TcxCustomDataController.
FixedTopRowCountInherited from TcxCustomDataController.
FocusedDataRowIndexInherited from TcxCustomDataController.
FocusedRecordIndexSpecifies the record index of the record with the current focus. Inherited from TcxCustomDataController.
FocusedRowIndexSpecifies the row index of the record with focus. Inherited from TcxCustomDataController.
GroupsProvides access to data groups in a grid control. Inherited from TcxCustomDataController.
HasRelationsInherited from TcxCustomDataController.
IsBrowsingInherited from TcxCustomDataController.
IsCancellingInherited from TcxCustomDataController.
IsCreatingLinkObjectInherited from TcxCustomDataController.
IsDetailExpandingInherited from TcxCustomDataController.
IsEditingSpecifies whether a data controller is in edit mode. Inherited from TcxCustomDataController.
IsPatternIndicates whether the current detail data controller is a pattern, as defined below. Inherited from TcxCustomDataController.
IsProviderModeInherited from TcxCustomDataController.
IsRowInfoValidInherited from TcxCustomDataController.
IsUpdatingItemsInherited from TcxCustomDataController.
ItemCountInherited from TcxCustomDataController.
ItemExpressionsSpecifies calculated field expressions for data items by their indexes. Inherited from TcxCustomDataController.
LockCountInherited from TcxCustomDataController.
LockGridModeNotifyCountInherited from TcxCustomDataController.
MultiSelectEnables selection of multiple records in a data controller. Inherited from TcxCustomDataController.
MultiThreadedOptionsProvides access to multi-threading settings. Inherited from TcxCustomDataController.
NewItemRecordIndexInherited from TcxCustomDataController.
NewItemRowFocusedInherited from TcxCustomDataController.
OptionsSpecifies data controller behavior flags. Inherited from TcxCustomDataController.
RecordCountDefines the number of records provided by the data controller. Inherited from TcxCustomDataController.
RelationsInherited from TcxCustomDataController.
RowCountReturns the number of rows in a data controller. Inherited from TcxCustomDataController.
RowFixedStateInherited from TcxCustomDataController.
SearchProvides access to the object enabling you to perform incremental searching programmatically. Inherited from TcxCustomDataController.
SortingBySummaryDataItemIndexInherited from TcxCustomDataController.
SummarySpecifies the set of summaries calculated by grid data. Inherited from TcxCustomDataController.
UseNewItemRowForEditingThis property is for internal use only. You will have no need to use it in applications. Inherited from TcxCustomDataController.
ValuesDetermines the value of a specific record and item. Inherited from TcxCustomDataController.

Methods

NameDescription
AddDataChangedListener(TObject,TNotifyEvent)Inherited from TcxCustomDataController.
AddDataChangeRefCountInherited from TcxCustomDataController.
AddItem(TObject)Inherited from TcxCustomDataController.
AppendAppends a new record to the underlying dataset. Inherited from TcxCustomDataController.
AppendRecordAppends a new record to a data controller. Inherited from TcxCustomDataController.
AreAllRowsSelectedIndicates if all rows the data controller displays are selected. Inherited from TcxCustomDataController.
Assign(TPersistent)Inherited from TPersistent.
AssignTo(TPersistent)Inherited from TPersistent.
BeginFullUpdatePrevents update notifications in the data controller and the object that displays its data until the EndFullUpdate method call. Inherited from TcxCustomDataController.
BeginUpdatePostpones sending update notifications by the data controller. Inherited from TcxCustomDataController.
BeginUpdateFieldsLocks field update notifications until the EndUpdateFields method is called. Inherited from TcxCustomDataController.
CancelCancels 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.
CheckBrowseModeInherited from TcxCustomDataController.
CheckDetailsBrowseMode protectedInherited from TcxCustomDataController.
CheckFocusedRowInherited from TcxCustomDataController.
CheckFocusedSelectedWhen selection of multiple records is enabled, this method selects the focused record. Inherited from TcxCustomDataController.
ClearBookmarkRemoves the current bookmark. Inherited from TcxCustomDataController.
ClearDetailLinkObject(Integer,Integer)Recreates a particular detail clone. Inherited from TcxCustomDataController.
ClearDetailsRecreates existing clones of detail data controllers associated with the current master data controller. Inherited from TcxCustomDataController.
ClearSelectionUnselects all rows in a data controller. Inherited from TcxCustomDataController.
ClearSelectionAnchorInherited from TcxCustomDataController.
ClearSorting(Boolean)Clears sorting applied to the data controller’s items. Inherited from TcxCustomDataController.
CollapseDetailsCollapses details of the current master data controller. Inherited from TcxCustomDataController.
CreateDetailLinkObject(TcxCustomDataRelation,Integer)Inherited from TcxCustomDataController.
CreateFilterInherited from TcxCustomDataController.
DataChangedNotifyLockedInherited from TcxCustomDataController.
DefaultCompare(Integer,Integer,Integer)Executes the default comparison routine for two specified values in a dataset field. Inherited from TcxCustomDataController.
DeleteFocusedDeletes 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.
DeleteSelectionDeletes selected rows from a data controller. Inherited from TcxCustomDataController.
EditActivates edit mode for the focused record. Inherited from TcxCustomDataController.
EndFullUpdateUnlocks the data controller and its associated visual object after the BeginFullUpdate method call. Inherited from TcxCustomDataController.
EndUpdateRe-enables sending update notifications by the data controller after they were suspended by calling BeginUpdate. Inherited from TcxCustomDataController.
EndUpdateFieldsRe-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.
GetEditingRecordIndexInherited from TcxCustomDataController.
GetEditValue(Integer,TcxDataEditValueSource)Inherited from TcxCustomDataController.
GetFilterDataValue(Integer,TcxCustomDataField)Inherited from TcxCustomDataController.
GetFilterItemFieldCaption(TObject)Inherited from TcxCustomDataController.
GetFilterItemFieldName(TObject)Inherited from TcxCustomDataController.
GetFocusedRecordIndexInherited from TcxCustomDataController.
GetFocusedRowIndexInherited 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.
GetHashCodeInherited from TObject.
GetIncrementalFilterFieldInherited from TcxCustomDataController.
GetIncrementalFilterTextInherited from TcxCustomDataController.
GetItem(Integer)Inherited from TcxCustomDataController.
GetItemCountInherited from TcxCustomDataController.
GetItemID(TObject) protectedInherited 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.
GetMasterDataControllerReturns the master data controller for the current detail data controller. Inherited from TcxCustomDataController.
GetMasterRecordIndexReturns the record index of the master record corresponding to the current clone of a detail data controller. Inherited from TcxCustomDataController.
GetMasterRelationInherited from TcxCustomDataController.
GetNamePathInherited from TPersistent.
GetNearestRowIndex(Integer)Inherited from TcxCustomDataController.
GetNewItemRecordIndexInherited from TcxCustomDataController.
GetOwnerInherited from TPersistent.
GetPatternDataControllerReturns a pattern data controller for a detail data controller. Inherited from TcxCustomDataController.
GetRecordCountInherited from TcxCustomDataController.
GetRecordId(Integer)Inherited from TcxCustomDataController.
GetRootDataControllerInherited from TcxCustomDataController.
GetRowCountInherited 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.
GetSelectedCountReturns the number of selected rows. Inherited from TcxCustomDataController.
GetSelectedRowIndex(Integer)Returns the row index of a selected row. Inherited from TcxCustomDataController.
GetSelectionAnchorRowIndexInherited from TcxCustomDataController.
GetSortingItemCountInherited from TcxCustomDataController.
GetSortingItemIndex(Integer)Inherited from TcxCustomDataController.
GetValue(Integer,Integer)Inherited from TcxCustomDataController.
GotoBookmarkLocates the record referred to by the current bookmark. Inherited from TcxCustomDataController.
GotoFirstMoves focus to the first visible row. Inherited from TcxCustomDataController.
GotoLastMoves focus to the last visible row. Inherited from TcxCustomDataController.
GotoNextMoves focus to the next visible row. Inherited from TcxCustomDataController.
GotoPrevMoves 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.
HasIncrementalFilterInherited from TcxCustomDataController.
InsertInserts 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.
IsBOFReturns a value indicating whether the first visible row is focused. Inherited from TcxCustomDataController.
IsBookmarkAvailableIndicates whether there is a bookmark available (created by the SaveBookmark method). Inherited from TcxCustomDataController.
IsBookmarkRow(Integer)Inherited from TcxCustomDataController.
IsDataLoadingInherited from TcxCustomDataController.
IsDetailDataControllerExist(Integer,Integer)Inherited from TcxCustomDataController.
IsDetailModeReturns a value indicating whether the current data controller is a detail of another data controller. Inherited from TcxCustomDataController.
IsDisplayFormatDefined(Integer,Boolean)Inherited from TcxCustomDataController.
IsEOFReturns a value indicating whether the last visible row is focused. Inherited from TcxCustomDataController.
IsGridModeIndicates whether your data controller is working in grid mode. Inherited from TcxCustomDataController.
IsImmediatePostInherited 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.
IsSelectionAnchorExistInherited from TcxCustomDataController.
ItemPropertiesChanged(Integer)Inherited from TcxCustomDataController.
LoadedInherited from TcxCustomDataController.
LoadFromStream(TStream)Populates your data controller with data from a stream. Inherited from TcxCustomDataController.
LockDataChangedNotifyInherited from TcxCustomDataController.
LockGridModeNotifyInherited from TcxCustomDataController.
MakeRecordVisible(Integer)Makes a record potentially visible by expanding the data group owning it. Inherited from TcxCustomDataController.
MoveBy(Integer)Inherited from TcxCustomDataController.
MultiSelectionSyncGroupWithChildrenIndicates 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.
PostEditingDataPosts edited data to a data source. Inherited from TcxCustomDataController.
RefreshInherited from TcxCustomDataController.
RefreshExternalDataForces a data controller to reload data from a data source. Inherited from TcxCustomDataController.
RemoveDataChangedListener(TObject,TNotifyEvent)Inherited from TcxCustomDataController.
RemoveDataChangeRefCountInherited from TcxCustomDataController.
RemoveItem(TObject)Inherited from TcxCustomDataController.
ResetHasChildrenFlagInherited from TcxCustomDataController.
ResetIncrementalFilterInherited from TcxCustomDataController.
ResetRelationByItem(TObject)Inherited from TcxCustomDataController.
RestoreDataSetPosInherited from TcxCustomDataController.
RestoreKeysRestores the record identifiers of the expanded master rows, grouping rows and selected rows. Inherited from TcxCustomDataController.
SaveBookmarkSaves the focused record as a bookmark. Inherited from TcxCustomDataController.
SaveDataSetPosInherited from TcxCustomDataController.
SaveKeysSaves 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.
SelectAllSelects all potentially visible rows in the current data controller. Inherited from TcxCustomDataController.
SelectFromAnchor(Integer,Boolean)Inherited from TcxCustomDataController.
SelectRows(Integer,Integer)Selects a 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.
SetFocusInherited 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.
SortByDisplayTextChangedInherited from TcxCustomDataController.
SyncSelected(Boolean)Allows you to select/unselect the focused row when multiple row selection is disabled. Inherited from TcxCustomDataController.
SyncSelectionFocusedRecordInherited from TcxCustomDataController.
ToStringInherited from TObject.
UnlockDataChangedNotifyInherited from TcxCustomDataController.
UnlockGridModeNotifyInherited from TcxCustomDataController.
UpdateAction(TBasicAction)Inherited from TcxCustomDataController.
UpdateDataInherited from TcxCustomDataController.
UpdateFields protectedInherited from TcxCustomDataController.
UpdateItemIndexesInherited 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

NameDescription
OnAfterCancelOccurs after canceling the modifications to the active record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnAfterDeleteAllows you to perform specific actions after the data controller deletes a record. Inherited from TcxCustomDataController.
OnAfterInsertOccurs after inserting a new record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnAfterPostOccurs after saving changes made to a record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnBeforeCancelOccurs before canceling modifications to the active record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnBeforeDeleteAllows you to perform specific actions when the data controller is about to delete a record. Inherited from TcxCustomDataController.
OnBeforeImmediatePostInherited from TcxCustomDataController.
OnBeforeInsertOccurs before inserting a new record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnBeforePostOccurs before saving changes made to the modified record if working in unbound or provider mode. Inherited from TcxCustomDataController.
OnCanSelectRecord protectedInherited from TcxCustomDataController.
OnCompareAllows you to implement a custom sorting algorithm. Inherited from TcxCustomDataController.
OnDataChangedOccurs on changing data provided by the data controller. Inherited from TcxCustomDataController.
OnDetailCollapsedOccurs after the details of a particular master record have been collapsed. Inherited from TcxCustomDataController.
OnDetailCollapsingOccurs when the details of a particular master record are about to be collapsed. Inherited from TcxCustomDataController.
OnDetailExpandedOccurs after the details of a particular master record have been expanded. Inherited from TcxCustomDataController.
OnDetailExpandingOccurs when the details of a particular master record are about to be expanded. Inherited from TcxCustomDataController.
OnFilterRecordAllows you to implement a custom data filtering algorithm. Inherited from TcxCustomDataController.
OnFindCriteriaBeforeChangeEnables you to identify and track changes made to the data search criteria before they take effect on the data controller. Inherited from TcxCustomDataController.
OnFindCriteriaChangedEnables you to identify and track all data search criteria changes applied to the data controller. Inherited from TcxCustomDataController.
OnGroupingChangedOccurs after data grouping is changed. Inherited from TcxCustomDataController.
OnNewRecordAllows you to perform actions when the data controller is about to focus a new inserted record. Inherited from TcxCustomDataController.
OnRecordChangedFires in response to data changes. Inherited from TcxCustomDataController.
OnSortingChangedAllows you to respond to sorting changes. Inherited from TcxCustomDataController.
OnUpdateControlInherited from TcxCustomDataController.

See Also

TcxDataController Class

cxData Unit