RunningTotalFieldDefinition Class

Article
06/18/2008

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

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

Syntax

'Declaration
Public Class RunningTotalFieldDefinition
    Inherits SummaryFieldDefinition
    Implements IDisposable

public class RunningTotalFieldDefinition : SummaryFieldDefinition, IDisposable

Remarks

Retrieve a RunningTotalFieldDefinition object by index or by name through the Item Property of the RunningTotalFieldDefinitions collection.

Example

This example verifies that the datasource of the RunningTotalField object contains a field named Order Items in a table named Customer.

'Declaration

          Private Function VerifyRunningTotalFieldObjectDataSource(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 myDatabaseRunningTotalFieldDefinition As RunningTotalFieldDefinition = myFieldObject.DataSource
               results = (myDatabaseRunningTotalFieldDefinition.Kind = FieldKind.RunningTotalField) And _
                         (myDatabaseRunningTotalFieldDefinition.EvaluationCondition = RunningTotalCondition.NoCondition) And _
                         (myDatabaseRunningTotalFieldDefinition.ResetCondition = RunningTotalCondition.OnChangeOfGroup) And _
                         (myDatabaseRunningTotalFieldDefinition.ValueType = FieldValueType.NumberField) And _
                         Not (myDatabaseRunningTotalFieldDefinition.Group Is Nothing) And _
                         (myDatabaseRunningTotalFieldDefinition.Operation = SummaryOperation.Sum) And _
                         (myDatabaseRunningTotalFieldDefinition.OperationParameter = 1) And _
                         Not (myDatabaseRunningTotalFieldDefinition.SummarizedField Is Nothing) And _
                         Not (myDatabaseRunningTotalFieldDefinition.SecondarySummarizedField Is Nothing) And _
                         (myDatabaseRunningTotalFieldDefinition.Name = "Order Items") And _
                         (myDatabaseRunningTotalFieldDefinition.NumberOfBytes = 16) And _
                         (myDatabaseRunningTotalFieldDefinition.FormulaName = "")
             End If
             VerifyRunningTotalFieldObjectDataSource = results
          End Function

          private bool VerifyRunningTotalFieldObjectDataSource(ReportDocument reportDocument, String reportObjectName )
          {
             bool results = false;
             ReportObject reportObject = reportDocument.ReportDefinition.ReportObjects[reportObjectName];
             if (reportObject.Kind == ReportObjectKind.FieldObject)
             {
               FieldObject fieldObject = (FieldObject)reportObject;
               RunningTotalFieldDefinition databaseRunningTotalFieldDefinition =
                 (RunningTotalFieldDefinition)fieldObject.DataSource;
               results = ((databaseRunningTotalFieldDefinition.Kind == FieldKind.RunningTotalField) &&
                 (databaseRunningTotalFieldDefinition.EvaluationCondition == (object)RunningTotalCondition.NoCondition) &&
                 (databaseRunningTotalFieldDefinition.ResetCondition == (object)RunningTotalCondition.OnChangeOfGroup) &&
                 (databaseRunningTotalFieldDefinition.ValueType == FieldValueType.NumberField) &&
                 (databaseRunningTotalFieldDefinition.Group != null) &&
                 (databaseRunningTotalFieldDefinition.Operation == SummaryOperation.Sum) &&
                 (databaseRunningTotalFieldDefinition.OperationParameter == 0) &&
                 (databaseRunningTotalFieldDefinition.SummarizedField != null) &&
                 (databaseRunningTotalFieldDefinition.SecondarySummarizedField != null) &&
                 (databaseRunningTotalFieldDefinition.Name == "Order Items") &&
                 (databaseRunningTotalFieldDefinition.NumberOfBytes == 16) &&
                 (databaseRunningTotalFieldDefinition.FormulaName == ""));
             }
             return results;
          }

Inheritance Hierarchy

Object
   EngineObjectBase
      FieldDefinition
         SummaryFieldDefinition
            RunningTotalFieldDefinition

Version Information

Crystal Reports Basic for Visual Studio 2008

Supported since: Crystal Reports for Visual Studio .NET 2002