SummaryFieldDefinition Class

Article
06/18/2008

Represents a summary field used in the report. This class provides properties for getting information on summary fields in the report.

Namespace CrystalDecisions.CrystalReports.Engine Assembly CrystalDecisions.CrystalReports.Engine (CrystalDecisions.CrystalReports.Engine.dll)

Syntax

'Declaration
Public Class SummaryFieldDefinition
    Inherits FieldDefinition
    Implements IDisposable

public class SummaryFieldDefinition : FieldDefinition, IDisposable

Remarks

Retrieve a SummaryFieldDefinition object by index through the Item Property of the SummaryFieldDefinitions collection.

Example

This example verifies that a summary field's datasource contains a Salary field from the Customer table.

'Declaration

          Private Function VerifySummaryFieldObjectDataSource(ByVal myReportDocument As ReportDocument, ByVal reportObjectName As String) As Boolean
             Dim results As Boolean = False
             Dim myReportObject As ReportObject = myReportDocument.ReportDefinition.ReportObjects.Item(reportObjectName)
             If myReportObject.Kind = ReportObjectKind.FieldObject Then
               Dim myFieldObject As FieldObject = myReportObject
               Dim myDatabaseSummaryFieldDefinition As SummaryFieldDefinition = myFieldObject.DataSource
               results = (myDatabaseSummaryFieldDefinition.Kind = FieldKind.SummaryField) And _
                         (myDatabaseSummaryFieldDefinition.ValueType = FieldValueType.NumberField) And _
                         Not (myDatabaseSummaryFieldDefinition.Group Is Nothing) And _
                         (myDatabaseSummaryFieldDefinition.Operation = SummaryOperation.Average) And _
                         (myDatabaseSummaryFieldDefinition.OperationParameter = 1) And _
                         Not (myDatabaseSummaryFieldDefinition.SummarizedField Is Nothing) And _
                         Not (myDatabaseSummaryFieldDefinition.SecondarySummarizedField Is Nothing) And _
                         (myDatabaseSummaryFieldDefinition.Name = "Salary") And _
                         (myDatabaseSummaryFieldDefinition.NumberOfBytes = 16) And _
                         (myDatabaseSummaryFieldDefinition.FormulaName = "")
             End If
             VerifySummaryFieldObjectDataSource = results
          End Function

          private bool VerifySummaryFieldObjectDataSource(ReportDocument reportDocument, String reportObjectName )
          {
             bool results = false;
             ReportObject reportObject = reportDocument.ReportDefinition.ReportObjects[reportObjectName];
             if (reportObject.Kind == ReportObjectKind.FieldObject)
             {
               FieldObject fieldObject = (FieldObject)reportObject;
               SummaryFieldDefinition databaseSummaryFieldDefinition =
                 (SummaryFieldDefinition)fieldObject.DataSource;
               results = ((databaseSummaryFieldDefinition.Kind == FieldKind.SummaryField) &&
                 (databaseSummaryFieldDefinition.ValueType == FieldValueType.NumberField) &&
                 (databaseSummaryFieldDefinition.Group != null) &&
                 (databaseSummaryFieldDefinition.Operation == SummaryOperation.Average) &&
                 (databaseSummaryFieldDefinition.OperationParameter == 1) &&
                 (databaseSummaryFieldDefinition.SummarizedField != null) &&
                 (databaseSummaryFieldDefinition.SecondarySummarizedField != null) &&
                 (databaseSummaryFieldDefinition.Name == "Salary") &&
                 (databaseSummaryFieldDefinition.NumberOfBytes == 16) &&
                 (databaseSummaryFieldDefinition.FormulaName == ""));
             }
             return results;
          }

Inheritance Hierarchy

Object
   EngineObjectBase
      FieldDefinition
         SummaryFieldDefinition

Version Information

Crystal Reports Basic for Visual Studio 2008

Supported since: Crystal Reports for Visual Studio .NET 2002