Datasnap.DBClient.TCustomClientDataSet Properties

From RAD Studio API Documentation
Jump to: navigation, search

ActivepublicSpecifies whether or not a dataset is open.
ActiveAggspublicLists the maintained aggregates supported by the current index.
ActiveRecordprotectedIndicates the index of the active record in the internal cache of records.
AggFieldspublicContains any aggregate fields.
AggregatesprotectedLists all aggregates that apply to the client dataset.
AggregatesActiveprotectedSpecifies whether the client dataset calculates and maintains aggregate values.
AppServerpublicProvides access to the interface the client dataset uses to communicate with a provider.
AutoCalcFieldsprotectedDetermines when the OnCalcFields event is triggered and when lookup field values are calculated.
BlobFieldCountprotectedIndicates the number of columns in the dataset that represent Binary large object (BLOB) fields.
BlockReadSizepublicDetermines how many record buffers are read in each block.
BofpublicIndicates whether the first record in the dataset is active.
BookmarkpublicSpecifies the current bookmark in the dataset.
BookmarkSizeprotectedIndicates the number of bytes used to represent a bookmark.
BufferCountprotectedIndicates the number of records in the internal cache.
BuffersprotectedProvides indexed access to the record buffers in the internal cache.
CalcBufferprotectedPoints to the record buffer used during an OnCalcFields event.
CalcFieldsSizeprotectedIndicates the number of bytes in a record buffer dedicated to storing calculated fields and lookup fields.
CanModifypublicIndicates whether the dataset permits write access to data.
ChangeCountpublicIndicates the number of changes in the change log.
CloneSourcepublicIndicates the client dataset (if any) with which this client dataset shares data.
CommandTextprotectedSpecifies an SQL command to be executed by the database server.
ComObjectpublicSpecifies the interface reference implemented by the component.
ComponentCountpublicIndicates the number of components owned by the component.
ComponentIndexpublicIndicates the position of the component in its owner's Components property array.
ComponentspublicLists all components owned by the component.
ComponentStatepublicDescribes the current state of the component, indicating when a component needs to avoid certain actions.
ComponentStylepublicGoverns the behavior of the component.
ConnectionBrokerpublicSpecifies a connection broker that handles the connection to an application server.
ConstraintsprotectedSpecifies record-level constraints that must be met when editing the data.
CurrentRecordprotectedIndicates the index of the current record in the internal cache of record buffers.
DatapublicRepresents the data of the client dataset in a transportable format.
DataSetFieldpublicIndicates the persistent TDataSetField object that owns a nested dataset.
DataSizepublicIndicates the number of bytes required to represent the Data property.
DataSourcepublicRepresents the data source of another dataset that supplies values to the dataset.
DeltapublicRepresents a packet of change log data.
DesignerpublicReturns a pointer to the DataSet designer for the dataset.
DesignInfopublicContains information used by the Form designer.
DisableStringTrimprotectedSpecifies whether trailing spaces are trimmed from field values when records are posted.
DisposedprotectedDisposed is a read-only property that shows the current state of this object.
DSBaseprotectedSpecifies the interface the client dataset uses to communicate with classes in Midas.dll or Midaslib.dcu (on Windows), or (on Linux).
DSCursorprotectedProvides access to the interface for the client dataset's data cursor.
EofpublicIndicates whether a dataset is positioned at the last record.
FetchOnDemandprotectedIndicates whether to fetch data packets from the provider on an as-needed basis.
FieldCountpublicIndicates the number of field components associated with the dataset.
FieldDefListpublicPoints to the list of field definitions for the dataset.
FieldDefsprotectedPoints to the list of field definitions for the dataset.
FieldListpublicLists the field components of a dataset.
FieldNoOfsprotectedSpecifies the offset needed to convert indexes in the Fields property to field numbers.
FieldOptionsprotectedSpecifies the options of the dataset fields.
FieldspublicLists all non-aggregate field components of the dataset.
FieldValuespublicProvides access to the values for all fields in the active record for the dataset.
FileNamepublicSpecifies a file that stores the data of the client dataset.
FilterprotectedSpecifies the text of the current filter for a dataset.
FilteredprotectedSpecifies whether or not filtering is active for a dataset.
FilterOptionsprotectedSpecifies whether or not filtering is case insensitive, and whether or not partial comparisons are permitted when filtering records.
FoundpublicIndicates whether or not moving to a different record is successful.
GroupingLevelpublicIndicates the depth of grouping support provided by the current index.
HasAppServerpublicIndicates whether the client dataset is connected to a provider.
IndexDefsprotectedContains information about the indexes for a client dataset.
IndexFieldCountpublicIndicates the number of fields that make up the current index.
IndexFieldNamespublicLists the fields to use as an index.
IndexFieldspublicSpecifies the fields associated with the current index.
IndexNameprotectedIdentifies an index for the client dataset.
InternalCalcFieldsprotectedIndicates whether the dataset includes internally calculated fields.
IsUniDirectionalpublicIndicates whether the dataset is unidirectional.
KeyExclusivepublicSpecifies the upper and lower boundaries for a range.
KeyFieldCountpublicSpecifies the number of fields to use when conducting a partial key search on a multifield key.
KeySizepublicIndicates the size of the current key used for the dataset.
LogChangespublicIndicates whether to maintain a change log separate from the data.
MasterFieldspublicNames one or more fields in a master table to link with corresponding fields in this dataset in order to establish a master-detail relationship.
MasterSourceprotectedSpecifies a data source component for the master dataset when establishing a detail-master relationship between this dataset and another one.
ModifiedpublicIndicates whether the active record is modified.
NamepublishedSpecifies the name of the component as referenced in code.
NestedDataSetClassprotectedIndicates the class type to use when creating nested datasets.
NestedDataSetsprotectedLists all nested datasets.
ObjectViewprotectedSpecifies whether fields are stored hierarchically or flattened out in the Fields property.
ObserverspublicIndicates the TObservers object added to the TComponent.
OwnerpublicIndicates the component that is responsible for streaming and freeing this component.
PacketRecordspublicIndicates the number or type of records in a single data packet.
ParamsprotectedContains parameter values that are sent to the provider.
ProviderEOFprotectedIndicates whether the client dataset has all of its data.
ProviderNamepublicSpecifies the name of a provider component that supplies data to and applies updates from the client dataset.
ReadOnlyprotectedSpecifies whether the client dataset is read-only for this application.
RecNopublicIndicates the active record number in the dataset.
RecordCountpublicIndicates the total number of records associated with the dataset.
RecordSizepublicIndicates the size of a record in the dataset.
RemoteServerpublicSpecifies the connection component that this client dataset uses to connect to an application server.
SavePointpublicRepresents the current state of edits when logging changes.
SparseArrayspublicDetermines whether a unique TField object is created for each element of an array field.
StatepublicIndicates the current operating mode of the dataset.
StatusFilterpublicFilters the client dataset so that it exposes only those records with a specific update status.
StoreDefsprotectedIndicates whether field and index definitions are saved with the client dataset.
TagpublishedStores a NativeInt integral value as a part of a component.
VCLComObjectpublicRepresents information used internally by components that support COM.
XMLDatapublicRepresents the data of the client dataset in XML.