FormulaFieldDefinition.Check Method

Article
06/18/2008

Checks the formula. If there is a syntax error it returns an error string and false.

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

Syntax

'Declaration
Public Overrideable Function Check ( _
    ByRef errString As String _ 
) As Boolean

public virtual bool Check (
    ref string errString
)

Parameters

errString
If there is a syntax error then errString contains the error, otherwise errString is empty.

Return Value

A Boolean value, indicating if the formula syntax is correct.

Example

The below method assigns a new formula to the specified FormulaField and then checks that the formula is correct.

'Declaration

      Public Sub CheckFormula _
         (ByVal formulaText As String, ByVal formulaFieldName As String)

         Dim isCorrect As Boolean
         Dim errString As String
         Dim formulaField As FormulaFieldDefinition

         formulaField = _
            Report.DataDefinition.FormulaFields.Item(formulaFieldName)
         formulaField.Text = formulaText
         isCorrect = formulaField.Check(errString)

         If Not (isCorrect) Then MsgBox(errString)
      End Sub

      private void CheckFormula(string formulaText, string formulaFieldName)
      {
         bool isCorrect = true;
         String errString = "";
         FormulaFieldDefinition formulaField;

         formulaField =
            Report.DataDefinition.FormulaFields[formulaFieldName];
         formulaField.Text = formulaText;
         isCorrect = formulaField.Check(ref errString);

         if (!isCorrect) MessageBox.Show(errString);
      }

Version Information

Crystal Reports Basic for Visual Studio 2008

Supported since: Crystal Reports for Visual Studio .NET 2002