IDataReaderExtension.IsAggregationField Method
Indicates whether the data is aggregated by the field with the given index.
Namespace: Microsoft.ReportingServices.DataProcessing
Assemblies: Microsoft.ReportingServices.SharePoint.UI.WebParts (in Microsoft.ReportingServices.SharePoint.UI.WebParts.dll)
Microsoft.ReportingServices.Interfaces (in Microsoft.ReportingServices.Interfaces.dll)
Syntax
'Declaration
Function IsAggregationField ( _
index As Integer _
) As Boolean
'Usage
Dim instance As IDataReaderExtension
Dim index As Integer
Dim returnValue As Boolean
returnValue = instance.IsAggregationField(index)
bool IsAggregationField(
int index
)
bool IsAggregationField(
int index
)
abstract IsAggregationField :
index:int -> bool
function IsAggregationField(
index : int
) : boolean
Parameters
- index
Type: System.Int32
The index of the field within the record.
Return Value
Type: System.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.