FireDAC.Comp.DataSet.TFDAutoIncField.ClientAutoIncrement

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: property
Visibility: published
Source:
FireDAC.Comp.DataSet.pas
FireDAC.Comp.DataSet.hpp
Unit: FireDAC.Comp.DataSet
Parent: TFDAutoIncField

Delphi

property ClientAutoIncrement: Boolean read FClientAutoIncrement

C++

__property bool ClientAutoIncrement = {read=FClientAutoIncrement, write=SetClientAutoIncrement, default=1};

Description

Specifies when the dataset needs to generate the autoincrementing value for the new record column.

When setting the ClientAutoIncrement property to True (default value), the dataset generates the autoincrementing value for the new record column. 

The dataset uses an internal autoincrementing value generator. The initial value is equal to AutoIncrementSeed. The value is incremented for the new record using AutoIncrementStep. After the dataset is closed, the internal autoincrementing value generator is reset to AutoIncrementSeed

This is useful when CachedUpdates is True.

Example

FDQuery1.CachedUpdates := True;
FDQuery1.Open;
FDQuery1.Append;
....
FDQuery1.Post;
// TFDAutoIncField(FDQuery1.Fields[0]).Value -> -1
FDQuery1.Append;
....
FDQuery1.Post;
// TFDAutoIncField(FDQuery1.Fields[0]).Value -> -2
FDQuery1.Append;
....
FDQuery1.Post;
// TFDAutoIncField(FDQuery1.Fields[0]).Value -> -3
FDQuery1.ApplyUpdates;

See Also