IDataReaderExtension.IsAggregationField(Int32) Method

Reference

Definition

Namespace:: Microsoft.ReportingServices.DataProcessing

Assemblies:: Microsoft.ReportingServices.Interfaces.dll, Microsoft.ReportingServices.SharePoint.UI.WebParts.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Indicates whether the data is aggregated by the field with the given index.

public:
 bool IsAggregationField(int index);

public bool IsAggregationField (int index);

abstract member IsAggregationField : int -> bool

Public Function IsAggregationField (index As Integer) As Boolean

Parameters

index: Int32

The index of the field within the record.

Returns

Boolean

A value of true if the current row is an aggregation field; otherwise, false.

Remarks

The IsAggregationField method 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

The IsAggregationField method returns a Boolean value for each row indicating that the field at the current index is an aggregation field, that is, the field is used in aggregations. In the previous example, the fields at index 0 and index 1 for row one should return true. In contrast, field index 1 for row two should return false. For row nine, both field index 0 and 1 should return false. Field index 2, the Sales field, returns false for all rows.

Applies to

Condividi tramite