Datasnap.DBClient.TAggregate.Active

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: property
Visibility: published
Source:
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Unit: Datasnap.DBClient
Parent: TAggregate

Delphi

property Active: Boolean read FActive write SetActive default False;

C++

__property bool Active = {read=FActive, write=SetActive, default=0};

Description

Indicates whether the aggregate should be calculated.

Use the Active property to indicate that the aggregate value should be maintained. If Active is false, the value of the aggregate is never calculated.

If Active is true, the aggregate value is calculated unless:

It summarizes records over a group not defined by the current index.

The client dataset's AggregatesActive property is false.

Note: To determine whether the aggregate is currently maintained, read the InUse property.

See Also