IDataReaderExtension.AggregationFieldCount Property

Definition

Gets the number of fields by which the data is aggregated.

public:
 property int AggregationFieldCount { int get(); };
public int AggregationFieldCount { get; }
member this.AggregationFieldCount : int
Public ReadOnly Property AggregationFieldCount As Integer

Property Value

When not positioned in a valid record set, 0; otherwise the number of aggregation columns in the current record. The default is -1.

Remarks

The AggregationFieldCount property enables you to supply specific, aggregation information about your result set to the report server. Take, for instance, the following result set:

City          State          Sales  
====================================  
Seattle       WA             150.65  
Seattle       (null)         150.65  
Tacoma        WA              75.54  
Tacoma        (null)          75.54  
(null)        WA             226.19  
Portland      OR             112.25  
Portland      (null)         112.25  
(null)        OR             112.25  
(null)        (null)         338.44  

You should return an integer value representing the number of fields that are aggregation fields for each row in your result set. In the previous example, AggregationFieldCount should return 2 for the first row, 1 for the second row, 2 for the third row and so forth. For row nine, AggregationFieldCount should return 0.

After executing a query that does not return rows, AggregationFieldCount should return -1.

Applies to