Back to Devexpress

TcxCustomDataController Methods

vcl-cxcustomdata-dot-tcxcustomdatacontroller-dot-underscore-methods.md

latest26.2 KB
Original Source

TcxCustomDataController Methods

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

NameDescription
AddDataChangedListener(TObject,TNotifyEvent)
AddDataChangeRefCount
AddItem(TObject)
AppendAppends a new record to the underlying dataset.
AppendRecordAppends a new record to a data controller.
AreAllRowsSelectedIndicates if all rows the data controller displays are selected.
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.
BeginUpdatePostpones sending update notifications by the data controller.
BeginUpdateFieldsLocks field update notifications until the EndUpdateFields method is called.
CancelCancels 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
CheckFocusedSelectedWhen selection of multiple records is enabled, this method selects the focused record.
ClearBookmarkRemoves the current bookmark.
ClearDetailLinkObject(Integer,Integer)Recreates a particular detail clone.
ClearDetailsRecreates existing clones of detail data controllers associated with the current master data controller.
ClearSelectionUnselects all rows in a data controller.
ClearSelectionAnchor
ClearSorting(Boolean)Clears sorting applied to the data controller’s items.
CollapseDetailsCollapses 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.
DeleteFocusedDeletes the focused row in a data controller.
DeleteRecord(Integer)Deletes a data record referenced by a record index (in unbound or provider mode only).
DeleteSelectionDeletes selected rows from a data controller.
EditActivates edit mode for the focused record.
EndFullUpdateUnlocks the data controller and its associated visual object after the BeginFullUpdate method call.
EndUpdateRe-enables sending update notifications by the data controller after they were suspended by calling BeginUpdate.
EndUpdateFieldsRe-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)
GetHashCodeInherited 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)
GetMasterDataControllerReturns the master data controller for the current detail data controller.
GetMasterRecordIndexReturns the record index of the master record corresponding to the current clone of a detail data controller.
GetMasterRelation
GetNamePathInherited from TPersistent.
GetNearestRowIndex(Integer)
GetNewItemRecordIndex
GetOwnerInherited from TPersistent.
GetPatternDataControllerReturns 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.
GetSelectedCountReturns the number of selected rows.
GetSelectedRowIndex(Integer)Returns the row index of a selected row.
GetSelectionAnchorRowIndex
GetSortingItemCount
GetSortingItemIndex(Integer)
GetValue(Integer,Integer)
GotoBookmarkLocates the record referred to by the current bookmark.
GotoFirstMoves focus to the first visible row.
GotoLastMoves focus to the last visible row.
GotoNextMoves focus to the next visible row.
GotoPrevMoves 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
InsertInserts a new record in a data controller.
InsertRecord(Integer)Inserts a new empty record in the current data controller.
IsBOFReturns a value indicating whether the first visible row is focused.
IsBookmarkAvailableIndicates whether there is a bookmark available (created by the SaveBookmark method).
IsBookmarkRow(Integer)
IsDataLoading
IsDetailDataControllerExist(Integer,Integer)
IsDetailModeReturns a value indicating whether the current data controller is a detail of another data controller.
IsDisplayFormatDefined(Integer,Boolean)
IsEOFReturns a value indicating whether the last visible row is focused.
IsGridModeIndicates 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)
MultiSelectionSyncGroupWithChildrenIndicates if group rows synchronize their selected state with child rows.
Post(Boolean)Posts a record to a data source.
PostEditingDataPosts edited data to a data source.
Refresh
RefreshExternalDataForces a data controller to reload data from a data source.
RemoveDataChangedListener(TObject,TNotifyEvent)
RemoveDataChangeRefCount
RemoveItem(TObject)
ResetHasChildrenFlag
ResetIncrementalFilter
ResetRelationByItem(TObject)
RestoreDataSetPos
RestoreKeysRestores the record identifiers of the expanded master rows, grouping rows and selected rows.
SaveBookmarkSaves the focused record as a bookmark.
SaveDataSetPos
SaveKeysSaves 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)
SelectAllSelects all potentially visible rows in the current data controller.
SelectFromAnchor(Integer,Boolean)
SelectRows(Integer,Integer)Selects a 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
ToStringInherited 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.

See Also

TcxCustomDataController Class

TcxCustomDataController Members

cxCustomData Unit