CompileFormula(IUltraCalcReference,String,Boolean) Method

Compiles the specified formula. Returns an instance of IUltraCalcFormula which represents a formula. Throws NullReferenceException if baseReference or formula is null. NOTE: This method does not add the formula to the calculation network.

Syntax

Visual Basic

'Declaration
 
Overloads Function CompileFormula( _
   ByVal baseReference As IUltraCalcReference, _
   ByVal formula As String, _
   ByVal suppressSyntaxErrorEvent As Boolean _
) As IUltraCalcFormula

C#

IUltraCalcFormula CompileFormula( 
   IUltraCalcReference baseReference,
   string formula,
   bool suppressSyntaxErrorEvent
)

Parameters

baseReference

Base reference to use for the reference parsing. Returned formula instance will make use this reference as its base reference during parsing as well as during evaluation time to resolve relative references.

formula

The formula string.

suppressSyntaxErrorEvent

Pass in true to prevent the Syntax error event from firing.

Remarks

Returns an instance of IUltraCalcFormula. IUltraCalcFormula has information on any syntax or reference errors.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2