From RAD Studio API Documentation
Jump to: navigation, search


property AggregatesActive: Boolean read FAggregatesActive write SetAggsActive default False;


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


Type Visibility Source Unit Parent
property protected
Datasnap.DBClient TCustomClientDataSet


Specifies whether the client dataset calculates and maintains aggregate values.

Use AggregatesActive to indicate whether the client dataset should maintain aggregate values. When AggregatesActive is False (the default), the client dataset does not support maintained aggregates. This allows the client dataset to avoid the overhead of calculating values that the application is not using. When AggregatesActive is True, the client dataset calculates and maintains all aggregate values specified by the Aggregates property that are compatible with the current index.

When aggregates are maintained, the Value method of every active aggregate object returns a value that reflects the current data in the client dataset. When users edit the data in the dataset, these values are recalculated to reflect the user's changes.

Note: To selectively enable and disable aggregates rather than turning them all on or off at once, use the Active property of individual TAggregate objects. These objects are available through the Aggregates property.

See Also