DBClient.TCustomClientDataSet Properties

From RAD Studio VCL Reference
Jump to: navigation, search

Delphi Information

property Aggregates: TAggregates read FAggregates write SetAggregates;

Lists all aggregates that apply to the client dataset.

property AggregatesActive: Boolean read FAggregatesActive write SetAggsActive;

Specifies whether the client dataset calculates and maintains aggregate values.

property CommandText: WideString read FCommandText write SetCommandText;

Specifies an SQL command to be executed by the database server.

property DisableStringTrim: Boolean read FDisableStringTrim write SetDisableStringTrim;

Specifies whether trailing spaces are trimmed from field values when records are posted.

property DSBase: IDSBase read FDSBase write FDSBase;

Specifies the interface the client dataset uses to communicate with classes in Midas.dll or Midaslib.dcu (on Windows) or midas.so (on Linux).

property DSCursor: IDSCursor read FDSCursor;

Provides access to the interface for the client dataset's data cursor.

property IndexDefs: TIndexDefs read GetIndexDefs write SetIndexDefs;

Contains information about the indexes for a client dataset.

property IndexName: WideString read GetIndexName write SetIndexName;

Identifies an index for the client dataset.

property IsClone: Boolean read GetIsClone;
property FetchOnDemand: Boolean read FFetchOnDemand write FFetchOnDemand;

Indicates whether to fetch data packets from the provider on an as-needed basis.

property MasterSource: TDataSource read GetDataSource write SetDataSource;

Specifies a data source component for the master dataset when establishing a detail-master relationship between this dataset and another one.

property Params: TParams read FParams write SetParams;

Contains parameter values that are sent to the provider.

property ProviderEOF: Boolean read GetProviderEOF write SetProviderEOF;

Indicates whether the client dataset has all of its data.

property ReadOnly: Boolean read FReadOnly write SetReadOnly;

Specifies whether the client dataset is read-only for this application.

property StoreDefs: Boolean read FStoreDefs write FStoreDefs;

Indicates whether field and index definitions are saved with the client dataset.

property ProviderName: string read FProviderName write SetProviderName;

Specifies the name of a provider component that supplies data to and applies updates from the client dataset..

property FileName: string read FFileName write SetFileName;

Specifies a file that stores the data of the client dataset.

property ConnectionBroker: TConnectionBroker read FConnectionBroker write SetConnectionBroker;

Specifies a connection broker that handles the connection to an application server.

property IndexFieldNames: WideString read GetIndexFieldNames write SetIndexFieldNames;

Lists the fields to use as an index.

property MasterFields: WideString read GetMasterFields write SetMasterFields;

Names one or more fields in a master table to link with corresponding fields in this dataset in order to establish a master-detail relationship.

property PacketRecords: Integer read FPacketRecords write FPacketRecords;

Indicates the number or type of records in a single data packet.

property RemoteServer: TCustomRemoteServer read GetRemoteServer write SetRemoteServer;

Specifies the connection component that this client dataset uses to connect to an application server.

property HasAppServer: Boolean read GetHasAppServer;

Indicates whether the client dataset is connected to a provider.

property ActiveAggs: TList read GetActiveAggs;

Lists the maintained aggregates supported by the current index.

property ChangeCount: Integer read GetChangeCount;

Indicates the number of changes in the change log.

property CloneSource: TCustomClientDataSet read FCloneSource;

Indicates the client dataset (if any) with which this client dataset shares data.

property Data: OleVariant read GetData write SetData;

Represents the data of the client dataset in a transportable format.

property XMLData: string read GetXMLData write SetXMLData;

Represents the data of the client dataset in XML.

property AppServer: IAppServer read GetAppServer write SetAppServer;

Provides access to the interface the client dataset uses to communicate with a provider.

property DataSize: Integer read GetDataSize;

Indicates the number of bytes required to represent the Data property.

property Delta: OleVariant read GetDelta;

Represents a packet of change log data.

property GroupingLevel: Integer read FGroupingLevel;

Indicates the depth of grouping support provided by the current index.

property IndexFieldCount: Integer read GetIndexFieldCount;

Indicates the number of fields that make up the current index.

property IndexFields: TField read GetIndexField write SetIndexField;

Specifies the fields associated with the current index.

property KeyExclusive: Boolean read GetKeyExclusive write SetKeyExclusive;

Specifies the upper and lower boundaries for a range.

property KeyFieldCount: Integer read GetKeyFieldCount write SetKeyFieldCount;

Specifies the number of fields to use when conducting a partial key search on a multi-field key.

property KeySize: Word read FKeySize;

Indicates the size of the current key used for the dataset.

property LogChanges: Boolean read GetLogChanges write SetLogChanges;

Indicates whether to maintain a change log separate from the data.

property SavePoint: Integer read GetSavePoint write SetSavePoint;

Represents the current state of edits when logging changes.

property StatusFilter: TUpdateStatusSet read FStatusFilter write SetStatusFilter;

Filters the client dataset so that it exposes only those records with a specific update status.

property Ranged: Boolean read FRanged;


Unit: DBClient

Type: property

Visibility: public

Member Of: TCustomClientDataSet

C++ Information

__property Dbclient::TAggregates * Aggregates = {read=FAggregates,write=SetAggregates};

Lists all aggregates that apply to the client dataset.

__property bool AggregatesActive = {read=FAggregatesActive,write=SetAggsActive};

Specifies whether the client dataset calculates and maintains aggregate values.

__property System::WideString CommandText = {read=FCommandText,write=SetCommandText};

Specifies an SQL command to be executed by the database server.

__property bool DisableStringTrim = {read=FDisableStringTrim,write=SetDisableStringTrim};

Specifies whether trailing spaces are trimmed from field values when records are posted.

__property System::DelphiInterface<Dsintf::IDSBase> DSBase = {read=FDSBase,write=FDSBase};

Specifies the interface the client dataset uses to communicate with classes in Midas.dll or Midaslib.dcu (on Windows) or midas.so (on Linux).

__property System::DelphiInterface<Dsintf::IDSCursor> DSCursor = {read=FDSCursor};

Provides access to the interface for the client dataset's data cursor.

__property Db::TIndexDefs * IndexDefs = {read=GetIndexDefs,write=SetIndexDefs};

Contains information about the indexes for a client dataset.

__property System::WideString IndexName = {read=GetIndexName,write=SetIndexName};

Identifies an index for the client dataset.

__property bool IsClone = {read=GetIsClone};
__property bool FetchOnDemand = {read=FFetchOnDemand,write=FFetchOnDemand};

Indicates whether to fetch data packets from the provider on an as-needed basis.

__property Db::TDataSource * MasterSource = {read=GetDataSource,write=SetDataSource};

Specifies a data source component for the master dataset when establishing a detail-master relationship between this dataset and another one.

__property Db::TParams * Params = {read=FParams,write=SetParams};

Contains parameter values that are sent to the provider.

__property bool ProviderEOF = {read=GetProviderEOF,write=SetProviderEOF};

Indicates whether the client dataset has all of its data.

__property bool ReadOnly = {read=FReadOnly,write=SetReadOnly};

Specifies whether the client dataset is read-only for this application.

__property bool StoreDefs = {read=FStoreDefs,write=FStoreDefs};

Indicates whether field and index definitions are saved with the client dataset.

__property System::UnicodeString ProviderName = {read=FProviderName,write=SetProviderName};

Specifies the name of a provider component that supplies data to and applies updates from the client dataset..

__property System::UnicodeString FileName = {read=FFileName,write=SetFileName};

Specifies a file that stores the data of the client dataset.

__property Dbclient::TConnectionBroker * ConnectionBroker = {read=FConnectionBroker,write=SetConnectionBroker};

Specifies a connection broker that handles the connection to an application server.

__property System::WideString IndexFieldNames = {read=GetIndexFieldNames,write=SetIndexFieldNames};

Lists the fields to use as an index.

__property System::WideString MasterFields = {read=GetMasterFields,write=SetMasterFields};

Names one or more fields in a master table to link with corresponding fields in this dataset in order to establish a master-detail relationship.

__property int PacketRecords = {read=FPacketRecords,write=FPacketRecords};

Indicates the number or type of records in a single data packet.

__property Dbclient::TCustomRemoteServer * RemoteServer = {read=GetRemoteServer,write=SetRemoteServer};

Specifies the connection component that this client dataset uses to connect to an application server.

__property bool HasAppServer = {read=GetHasAppServer};

Indicates whether the client dataset is connected to a provider.

__property Classes::TList * ActiveAggs = {read=GetActiveAggs};

Lists the maintained aggregates supported by the current index.

__property int ChangeCount = {read=GetChangeCount};

Indicates the number of changes in the change log.

__property Dbclient::TCustomClientDataSet * CloneSource = {read=FCloneSource};

Indicates the client dataset (if any) with which this client dataset shares data.

__property System::OleVariant Data = {read=GetData,write=SetData};

Represents the data of the client dataset in a transportable format.

__property System::UnicodeString XMLData = {read=GetXMLData,write=SetXMLData};

Represents the data of the client dataset in XML.

__property System::DelphiInterface<Midas::IAppServer> AppServer = {read=GetAppServer,write=SetAppServer};

Provides access to the interface the client dataset uses to communicate with a provider.

__property int DataSize = {read=GetDataSize};

Indicates the number of bytes required to represent the Data property.

__property System::OleVariant Delta = {read=GetDelta};

Represents a packet of change log data.

__property int GroupingLevel = {read=FGroupingLevel};

Indicates the depth of grouping support provided by the current index.

__property int IndexFieldCount = {read=GetIndexFieldCount};

Indicates the number of fields that make up the current index.

__property Db::TField * IndexFields = {read=GetIndexField,write=SetIndexField};

Specifies the fields associated with the current index.

__property bool KeyExclusive = {read=GetKeyExclusive,write=SetKeyExclusive};

Specifies the upper and lower boundaries for a range.

__property int KeyFieldCount = {read=GetKeyFieldCount,write=SetKeyFieldCount};

Specifies the number of fields to use when conducting a partial key search on a multi-field key.

__property unsigned short KeySize = {read=FKeySize};

Indicates the size of the current key used for the dataset.

__property bool LogChanges = {read=GetLogChanges,write=SetLogChanges};

Indicates whether to maintain a change log separate from the data.

__property int SavePoint = {read=GetSavePoint,write=SetSavePoint};

Represents the current state of edits when logging changes.

__property System::Set<Db::TUpdateStatus,0,3> StatusFilter = {read=FStatusFilter,write=SetStatusFilter};

Filters the client dataset so that it exposes only those records with a specific update status.

__property bool Ranged = {read=FRanged};


Unit: DBClient

Type: property

Visibility: public

Member Of: TCustomClientDataSet


Description

Embarcadero Technologies does not currently have any additional information. Please help us document this topic by using the Discussion page!

Retrieved from "http://docwiki.embarcadero.com/VCL/2010/e/index.php?title=DBClient.TCustomClientDataSet_Properties&oldid=42462"
Personal tools
Translations
Newest Version