IDataReaderExtension.IsAggregationField Method

Article
12/03/2008

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

Namespace: Microsoft.ReportingServices.DataProcessing
Assembly: Microsoft.ReportingServices.Interfaces (in microsoft.reportingservices.interfaces.dll)

Syntax

'Declaration
<StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey:="0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")> _
Function IsAggregationField ( _
    index As Integer _
) As Boolean

[StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey="0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")] 
bool IsAggregationField (
    int index
)

[StrongNameIdentityPermissionAttribute(SecurityAction::LinkDemand, PublicKey=L"0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")] 
bool IsAggregationField (
    int index
)

/** @attribute StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey="0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8") */ 
boolean IsAggregationField (
    int index
)

function IsAggregationField (
    index : int
) : boolean

Parameters

index
The index of the field within the record.

Return Value

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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms