Class GridFormulaEngine

Encapsulates the code required to parse and compute formulas. Hashtable properties maintain a Formula Library of functions as well as a list of dependent cells.

You can add and remove library functions.

Inheritance

System.Object

GridFormulaEngine

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Syncfusion.Windows.Forms.Grid

Assembly: Syncfusion.Grid.Windows.dll

Syntax

public class GridFormulaEngine

Constructors

GridFormulaEngine(GridModel)

Initialize the new instance for GridFormulaEngine class.

Declaration

public GridFormulaEngine(GridModel gridModel)

Parameters

Type	Name	Description
GridModel	gridModel	The GridModel from the underlying grid.

Fields

ACC

Get the account value

Declaration

public double ACC

Field Value

Type
System.Double

BIGNI

Get the big value

Declaration

public double BIGNI

Field Value

Type
System.Double

BIGNO

Get the big number

Declaration

public double BIGNO

Field Value

Type
System.Double

FormulaErrorStrings

String array that holds the strings used in error messages within the Formula Engine.

Declaration

public string[] FormulaErrorStrings

Field Value

Type
System.String[]

Remarks

If you want to change the error messages displayed within the Formula Engine, you can set the new strings into the appropriate position in the FormulaErrorStrings array. You should assign your new strings to the corresponding positions.

Examples

Here is the code that shows position of each string in FormulaErrorStrings:

       public string[] FormulaErrorStrings = new string[]
       {
           "binary operators cannot start an expression",    //0
           "cannot parse",                                    //1
           "bad library",                                    //2
           "invalid char in front of",                        //3
           "number contains 2 decimal points",                //4
           "expression cannot end with an operator",        //5
           "invalid characters following an operator",        //6
           "invalid character in number",                    //7
           "mismatched parentheses",                        //8
           "unknown formula name",                            //9
           "requires a single argument",                    //10
           "requires 3 arguments",                            //11
           "invalid Math argument",                        //12
           "requires 2 arguments",                            //13
           "bad index",                                    //14
           "too complex",                                    //15
           "circular reference: ",                            //16
           "missing formula",                                //17
           "improper formula",                                //18
           "invalid expression",                            //19
           "cell empty"                                    //20
           "bad formula",                                    //21
           "empty expression",                                //22
           "Virtual Mode required - set UsesVirtualDataSource", //23
           "mismatched string quotes",                     //24
           "wrong number of arguments",                    //25
           "invalid arguments",                            //26
           "iterations do not converge",                   //27
           "Control named '{0}' is already registered",    //28
        "Calculation overflow",                            //29
        "missing operand"                                //30
        "unknown sheet"                                //30
       };

machineepsilon

Used to get the machine position

Declaration

public const double machineepsilon = 5E-16

Field Value

Type
System.Double

maxrealnumber

Used to get the maximum real number value

Declaration

public const double maxrealnumber = 1E+300

Field Value

Type
System.Double

minrealnumber

Used to get the minimum real number value

Declaration

public const double minrealnumber = 1E-300

Field Value

Type
System.Double

ParseArgumentSeparator

Character recognized by the parsing code as the delimiter for arguments in a named formula's argument list.

Declaration

[ThreadStatic]
public static char ParseArgumentSeparator

Field Value

Type
System.Char

ParseDecimalSeparator

Character recognized by the parsing engine as decimal separator for numbers.

Declaration

[ThreadStatic]
public static char ParseDecimalSeparator

Field Value

Type
System.Char

parsedKeyValue

determine thee parsed key value

Declaration

public string parsedKeyValue

Field Value

Type
System.String

Treat1900AsLeapYear

Specifies if 1900 should be treated as Leap Year (Excel Compatibility)

Declaration

public static bool Treat1900AsLeapYear

Field Value

Type
System.Boolean

unParsedKey

determine the unparsedkey value

Declaration

public string unParsedKey

Field Value

Type
System.String

ValidSheetChars

Used by the Syncfusion.Windows.Forms.Grid.GridFormulaEngine.ChangeGridSheetName(System.String,System.String,Syncfusion.Windows.Forms.Grid.GridModel,System.Boolean) method to decide what characters can precede a SheetName in a formula. The default value is "+-/*<>=(,:".

Declaration

[ThreadStatic]
public static string ValidSheetChars

Field Value

Type
System.String

Properties

ActiveFunctionName

Gets the function name of the active function call. Empty if not in a call.

Declaration

public string ActiveFunctionName { get; }

Property Value

Type
System.String

AllowShortCircuitIFs

Gets or sets a value indicating whether IF function calculations should specifically avoid computing the non-used alternative.

Declaration

public bool AllowShortCircuitIFs { get; set; }

Property Value

Type
System.Boolean

Remarks

The default value is false for code legacy consistency. When AllowShortCircuitIFs
is set true, only the necessary alternative of an IF function is computed. To support this behavior, a change in how nested IF function calculations are done is necessary. The default way of calculating nested functions is inside-out, with the inner most functions being computed to a value before the next outer function is evaluated. To support short circuiting IF functions, nested IF functions need to be computed from the outside-in to know what alternative needs to be evaluated. This outside-in calculation pattern only applies to IF functions, and only when AllowShortCircuitIFs is true.

CalculatingSuspended

Gets or sets a value indicating whether formulas are immediately calculated as dependent cells are changed.

Declaration

public bool CalculatingSuspended { get; set; }

Property Value

Type
System.Boolean

Remarks

Use this property to suspend calculations while a series of changes are made to dependent cells either by the user or programmatically. When the changes are complete, set this property to False, and then call Engine.RecalculateRange to recalculate the affected range. See the sample in GridFormulaCellModel.CalculatingSuspended.

CatchExceptionsInRecalculateRange

Gets or sets whether further calculations on a formula will be attempted in the RecalculateRange method if there is an exception raised during the parsing or calculating of the formula.

Declaration

public bool CatchExceptionsInRecalculateRange { get; set; }

Property Value

Type
System.Boolean

Remarks

The default value is false for backward compatibilty purposes. If you set this property to true, then during calls to RecalculateRange with forceCalculations = true, if an exception is raised during parsing or computing, the cell will display "#REF!". This property only has effect if you call RecalculateRange with the forceCalculations parameter set to true.

CloneableFormulaTags

Gets or sets a value indicating whether FormulaTags are cloned when setting one FormulaTag object equal to another.

Declaration

public static bool CloneableFormulaTags { get; set; }

Property Value

Type
System.Boolean

Remarks

This is by default set to False as normally the FormulaEngine expects to be working with referenced objects, and not clones of referenced objects.

CurrentRowNotationEnabled

Gets or sets a value indicating whether to enable / disable using row = 0 in formulas to represent the current row.

Declaration

public bool CurrentRowNotationEnabled { get; set; }

Property Value

Type
System.Boolean

Remarks

When this property is set True, entering zero as a row in a formula is interpreted to be the current row. Using the current row notation allows you to sort a column in the grid and maintain the relative formula. After sorting, you do have to call engine.RecalculateRange to allow the relative formulas to reset themselves. See the Grid\Samples\Quick Start\GridControlSort sample to see this sorting support in action.

Examples

Here is code that places a formula in column 4 that sums columns 1 and 3. Notice it just sets CellType and Text properties on the column style for the column. It is not required that you visit each cell in the column to assign such a formula.

//column 4 is formula col which used relative notation (row = 0)
//to enter the formulas as a simple string as the default value
//in the column
this.gridControl1.ColWidths[4] = 100;
this.gridControl1[0, 4].Text = "FormulaCell";
this.gridControl1.ColStyles[4].CellType = "FormulaCell";
this.gridControl1.ColStyles[4].Text = "= A0 + C0"; 

DependentCells

Gets a mapping between a cell and a list of formula cells that depend on it.

Declaration

public Hashtable DependentCells { get; }

Property Value

Type
System.Collections.Hashtable

Remarks

The key is the given cell, and the value is a Hashtable of cells containing formulas that reference this cell.

Examples

Here is code that will list formula cells affected by changing the given cell.

   public void DisplayAllAffectedCells()
   {
       GridFormulaEngine engine = ((GridFormulaCellModel)this.gridControl1.CellModels["FormulaCell"]).Engine;
    
       foreach(object o in engine.DependentCells.Keys)
       {
           string s1 = o as string;
           Console.Write(s1 + " affects ");
           Hashtable ht = (Hashtable) engine.DependentCells[s1];
           foreach(object o1 in ht.Keys)
           {
               string s2 = o1 as string;
               Console.Write(s2 + " ");
           }
           Console.WriteLine(string.Empty);
       }
   }

       Public Sub DisplayAllAffectedCells()
           Dim engine As GridFormulaEngine = CType(Me.gridControl1.CellModels("FormulaCell"), GridFormulaCellModel).Engine
           Dim o As Object
           For Each o In  engine.DependentCells.Keys
               Dim s1 As String = CStr(o)
               Console.Write((s1 + " affects "))
               Dim ht As Hashtable = CType(engine.DependentCells(s1), Hashtable)
               Dim o1 As Object
               For Each o1 In  ht.Keys
                   Dim s2 As String = CStr(o1)
                   Console.Write((s2 + " "))
               Next o1
               Console.WriteLine(string.Empty)
           Next o
       End Sub 'DisplayAllAffectedCells

DependentFormulaCells

Gets a mapping between a formula cell and a list of cells upon which it depends.

Declaration

public Hashtable DependentFormulaCells { get; }

Property Value

Type
System.Collections.Hashtable

Remarks

The key is the given formula cell, and the value is a Hashtable of cells that this formula cell references.

Examples

Here is code that lists formula cells affected by changing a given cell:

       public void DisplayAllFormulaDependencies()
       {
           GridFormulaEngine engine = ((GridFormulaCellModel)this.gridControl1.CellModels["FormulaCell"]).Engine;
           
          foreach(object o in engine.DependentFormulaCells.Keys)
          {
              string s1 = o as string;
              Console.Write(s1 + " depends upon ");
              Hashtable ht = (Hashtable) engine.DependentFormulaCells[s1];
              foreach(object o1 in ht.Keys)
              {
                  string s2 = o1 as string;
                  Console.Write(s2 + " ");
              }
              Console.WriteLine(string.Empty);
          }
      }

       Public Sub DisplayAllFormulaDependencies()
           Dim engine As GridFormulaEngine = CType(Me.gridControl1.CellModels("FormulaCell"), GridFormulaCellModel).Engine
   
           Dim o As Object
           For Each o In  engine.DependentFormulaCells.Keys
               Dim s1 As String = CStr(o)
               Console.Write((s1 + " depends upon "))
               Dim ht As Hashtable = CType(engine.DependentFormulaCells(s1), Hashtable)
               Dim o1 As Object
               For Each o1 In  ht.Keys
                   Dim s2 As String = CStr(o1) 
                   Console.Write((s2 + " "))
               Next o1
               Console.WriteLine(string.Empty)
           Next o
       End Sub 'DisplayAllFormulaDependencies

DependentNamedRangeCells

Gets hashtables containing cells that depend upon namedranges.

Declaration

public Hashtable DependentNamedRangeCells { get; }

Property Value

Type
System.Collections.Hashtable

Remarks

The key properties in DependentNamedRangeCells are namedranges. The value properties are hashtables.

DoCircularCheckInValidating

Gets or sets a value indicating whether circular references should be checked in the CurrentCell.Validating event.

Declaration

public bool DoCircularCheckInValidating { get; set; }

Property Value

Type
System.Boolean

ErrorStrings

A property that gets/sets list of # error strings.

Declaration

public ArrayList ErrorStrings { get; set; }

Property Value

Type
System.Collections.ArrayList

FixedReferenceOnlyOnPaste

Gets or sets a value indicating whether fixed references should be adjusted on other than paste.

Declaration

public bool FixedReferenceOnlyOnPaste { get; set; }

Property Value

Type
System.Boolean

ForceParsingOfLibraryFunctionArguments

Gets or sets a value indicating whether all function arguments are parsed using GridFormulaEngine.Parse.

Declaration

public bool ForceParsingOfLibraryFunctionArguments { get; set; }

Property Value

Type
System.Boolean

Remarks

If you are using NamedRanges or CurrentRowNotationEnabled inside function arguments, you should set this property to true to make sure the proper substitutions are done on the arguments.

ForceSaveCellInfo

Gets or sets a value indicating whether a SaveCellInfo event should be raised even if the affected cell is off-screen.

Declaration

public bool ForceSaveCellInfo { get; set; }

Property Value

Type
System.Boolean

Remarks

The default behavior is not to raise a SaveCellInfo event for off-screen cells when a value is modified that affects such cells. This is done for performance considerations. But if you need the SaveCellInfo event raised for every change, you can set this property to ensure this event is raised.

FormulaContextCell

Gets or sets the cell (in the column-row notation of A1 or E21) whose formula is being parsed or computed.

Declaration

public string FormulaContextCell { get; set; }

Property Value

Type
System.String

Remarks

This property should be set only if you are directly parsing and computing formulas by calling the Parse or ComputedValue methods. In this case, you should set the property before calling either method. FormulaContextCell is used to provide support for CurrentRowNotation, circular calculation checks, and reference updating.

FormulaCopyFlags

Gets or sets behavior for copy, paste, and drag-and-drop operations.

Declaration

public GridFormulaCopyFlags FormulaCopyFlags { get; set; }

Property Value

Type
GridFormulaCopyFlags

Examples

This example shows how to use the FormulaCopyFlags property.

// Sets the Copy, paste options of the formula cell in the grid.
GridFormulaEngine calculateEngine = new GridFormulaEngine(this.gridControl1.Model);
calculateEngine.FormulaCopyFlags = GridFormulaCopyFlags.ClipBoardFormula;
calculateEngine.FormulaCopyFlags = GridFormulaCopyFlags.NamedRangeReferencesUpdated;

' Sets the Copy, paste options of the formula cell in the grid.
Dim calculateEngine As New GridFormulaEngine(Me.gridControl1.Model)
calculateEngine.FormulaCopyFlags = GridFormulaCopyFlags.ClipBoardFormula
calculateEngine.FormulaCopyFlags = GridFormulaCopyFlags.NamedRangeReferencesUpdated

FunctionEngineContext

Gets the formula engine that holds the proper state information for LibraryFunction call.

Declaration

public static GridFormulaEngine FunctionEngineContext { get; }

Property Value

Type
GridFormulaEngine

Remarks

If you are adding your own custom library functions and need to access GridFormulaEngine members like GetCellsFromArgs or GetValueFromArg from your code, then you should use this static property to retrieve the proper GridFormulaEngine object. This only matters if you are using multiple grids that you have registered using RegisterGridAsSheet, and are adding your own custom formulas. Note that GridFormulaEngine.FunctionEngineContext is only defined within the scope of a library function call, and will be null at all other times.

Examples

Use GridFormulaEngine.FunctionEngineContext to retrieve the engine when writing custom functions.

public string ComputeSumPosNums(string args)
{
    GridFormulaEngine engine = GridFormulaEngine.FunctionEngineContext;
    string sum = string.Empty;
    foreach(string r in args.Split(new char[]{','}))
    {
        if(r.IndexOf(':') > -1) //is a cellrange
        {
            foreach(string s in engine.GetCellsFromArgs(r))
            {
                s1 = engine.GetValueFromArg(s).Replace("'",string.Empty);
                //... do some calculations to compute sum
            }
        }
    }    
    return sum.ToString();
}

Public Function ComputeSumPosNums(args As String) As String
   Dim engine As GridFormulaEngine = GridFormulaEngine.FunctionEngineContext
   Dim sum As String = string.Empty
   Dim r As String
   For Each r In  args.Split(New Char() {","c})
           If r.IndexOf(":"c) > - 1 Then 'is a cellrange
               Dim s As String
               For Each s In  engine.GetCellsFromArgs(r)
                   s1 = engine.GetValueFromArg(s).Replace("'", string.Empty)
                   '... do some calculations to compute sum
               Next s 
           End If
   Next r
   Return sum.ToString()
End Function 'ComputeSumPosNums

GetValueFromArgPreserveLeadingZeros

Gets or sets whether leading zeros are preserved in a call to GetValueFromArg(String).

Declaration

public bool GetValueFromArgPreserveLeadingZeros { get; set; }

Property Value

Type
System.Boolean

Remarks

If the value of arg is "0123" or a cell reference like A1 where A1 holds 0123, then the default behavior is for GetValueFromArg(arg) to return 123, stripping away any leading zeros. If you want calls to GetValueFromArg to preserve the leading zeros, then set GetValueFromArgPreserveLeadingZeros to true.

LibraryFunctions

Gets the current library functions.

Declaration

public Hashtable LibraryFunctions { get; }

Property Value

Type
System.Collections.Hashtable

Remarks

This field gives you direct access to all Library Functions. The function name serves as the hash key, and the function delegate serves as the hash value.

MarkUnknownSheetRanges

Gets or sets whether formulas involving unknown sheet names are marked with #REF! text.

Declaration

public bool MarkUnknownSheetRanges { get; set; }

Property Value

Type
System.Boolean

Remarks

The default value is false. When this property is false, the engine throws an unknown sheet name error when a formula uses a sheet name that has not been registered with the engine. If you want to avoid this exception being thrown, set this property to true. In this case, the cell will display #REF! and be ignored by the engine.

MaximumCircularChecks

Gets or sets the number of recursive checks done for circular references.

Declaration

public int MaximumCircularChecks { get; set; }

Property Value

Type
System.Int32

Remarks

When you edit a cell, the engine parsing will attempt to flag circular references as an error. This value sets the number of dependent cells it will check before assuming there is no circular reference. Checking every reference can be time consuming depending upon the formulas being used. This property lets you decide how many recursions the engine will allow when looking for circular references. The default value is -1 meaning no checks are done as you type formula into the cell. Setting this property to int.MaxValue will make the engine check all dependent cells for a circular reference.

MaximumRecursiveCalls

Gets or sets the maximum number of recursive calls that can be used to compute a cellvalue.

Declaration

public int MaximumRecursiveCalls { get; set; }

Property Value

Type
System.Int32

Remarks

This property comes into play when you have a calculated formula cell that depends on
another calculated formula that depends on another calculated formula and so on. If the 'depends on another formula' number exceeds MaximumRecursiveCalls, you will see a Too Complex message displayed in the cell. The default value is 100, but you can set it higher or lower depending upon your expected needs. The purpose of the limit is to avoid a circular reference locking up your application.

MaximumStackDepth

Gets or sets depth of the engine's calculation stack.

Declaration

public int MaximumStackDepth { get; set; }

Property Value

Type
System.Int32

Remarks

It is unlikely that you will need to adjust this value, as its default value of 100 is quite large. Any time a formula is to be computed, a Stack object is created with this number of elements to hold temporary calculations as the formula is being computed. For example, this formula: 1+1+1+...+1 requires a stack depth of 2 as there are only 2 temporary values needed as the formula is evaluated. However, this formula: 1+(1+(1+(1+1))) requires a depth of 5, as the five 1's are pushed onto the stack before the first addition (the right-most one) is performed.

NamedRangeCellCollection

Gets the named range Hashtable that holds the original case name as the value.

Declaration

public Hashtable NamedRangeCellCollection { get; }

Property Value

Type
System.Collections.Hashtable

Remarks

The key is the uppercase name and the value is the original name.

NamedRanges

Gets the named range Hashtable.

Declaration

public Hashtable NamedRanges { get; }

Property Value

Type
System.Collections.Hashtable

Remarks

The key is the uppercase name and the value is the range for this name.

Examples

This example shows how to use NamedRanges property.

// Adds the NamedRange to the NamedRange list.
GridFormulaEngine calculateEngine = new GridFormulaEngine(this.gridControl1.Model);
calculateEngine.NamedRanges.Add("A", 50);
calculateEngine.NamedRanges.Add("B", 25);

' Adds the NamedRange to the NamedRange list.
Dim calculateEngine As New GridFormulaEngine(Me.gridControl1.Model)
calculateEngine.NamedRanges.Add("A", 50)
calculateEngine.NamedRanges.Add("B", 25)

NamedRangesOriginalNames

Gets the named range Hashtable that holds the original case name as the value.

Declaration

public Hashtable NamedRangesOriginalNames { get; }

Property Value

Type
System.Collections.Hashtable

Remarks

The key is the uppercase name and the value is the original name.

NamedRangesSized

Gets namedranges in order of string length.

Declaration

protected ArrayList NamedRangesSized { get; }

Property Value

Type
System.Collections.ArrayList

NamedRangeValues

Contains the Name ranges of the formula cells

Declaration

public Hashtable NamedRangeValues { get; }

Property Value

Type
System.Collections.Hashtable

RethrowLibraryException

Gets or sets the value of RethrowLibraryException

Declaration

public bool RethrowLibraryException { get; set; }

Property Value

Type
System.Boolean

ReturnNAN

Gets or sets a value indicating whether numerical formulas involving cells that hold strings return an error.

Declaration

public bool ReturnNAN { get; set; }

Property Value

Type
System.Boolean

Remarks

The default behavior is for the values of cells that hold strings to be treated as a zero if those cells are used in numerical calculations. When this property is true, the calculation value is returned as double.NAN and an #Value! is displayed in the computed formula.

SupportBlanksInSheetNames

Gets or sets a value indicating whether blanks are treated as significant in sheet names.

Declaration

public bool SupportBlanksInSheetNames { get; set; }

Property Value

Type
System.Boolean

Remarks

Earlier versions of GridFormulaEngine did not support the use of blanks in sheet names. (They were treated as insignificant.) The current version does treat blanks as significant. If you want to revert to the prior treatment of blanks in sheet names, then set this property to false.

SuspendRefresh

Gets or sets whether to suspend recalculation from occurring more than once on RecalculateRange call or any cell value change for better performance. Default value is false.

Declaration

public bool SuspendRefresh { get; set; }

Property Value

Type
System.Boolean

TreatStringsAsZero

Gets of sets whether the FormulaEngine treats nonempty strings as zeros when they are encountered during calculations.

Declaration

public bool TreatStringsAsZero { get; set; }

Property Value

Type
System.Boolean

Remarks

The default value is false meaning that if a nonempty string is encountered during an arithmetic operation, it will be treated as zero.

UseCommonLibrary

Gets or sets a value indicating whether you want all grids to share the same collection of library functions.

Declaration

public static bool UseCommonLibrary { get; set; }

Property Value

Type
System.Boolean

UseNoAmpersandQuotes

Gets or sets a value indicating whether strings concatenated using the ampersand operator should be returned inside double quote marks.

Declaration

public bool UseNoAmpersandQuotes { get; set; }

Property Value

Type
System.Boolean

UsesVirtualDataSource

Gets or sets a value indicating whether the underlying data is virtually bound to the grid.

Declaration

public bool UsesVirtualDataSource { get; set; }

Property Value

Type
System.Boolean

Remarks

If the formula engine knows the data is stored within a GridControl.Data object, it can optimize data access. If the grid is being populated through virtual techniques (handling QueryCellInfo), the formula engine has to get the data through that means. The default value is to assume the data is coming from a virtual datasource. There are some other situations, like formulas in headers or frozen cells, when this property should be set to True.

WeekEndType

Gets the WeekEndType into the list

Declaration

public ArrayList WeekEndType { get; }

Property Value

Type
System.Collections.ArrayList

Methods

AddFunction(String, GridFormulaEngine.LibraryFunction)

Adds a function to the Function Library.

Declaration

public bool AddFunction(string name, GridFormulaEngine.LibraryFunction func)

Parameters

Type	Name	Description
System.String	name	The name of the function to be added.
GridFormulaEngine.LibraryFunction	func	The function to be added.

Returns

Type	Description
System.Boolean	True if successfully removed, False otherwise.

Remarks

LibraryFunction is a delegate the defines the signature of functions that you can add to the Function Library.

public delegate string LibraryFunction(string args);

Examples

This example shows how to add a function to the library.

GridFormulaCellModel myModel = this.gridControl1.CellModels["FormulaCell"] as GridFormulaCellModel;
GridFormulaEngine calculateEngine = new GridFormulaEngine(this.gridControl1.Model);
// Add the custom-function to the library functions.
myModel.Engine.AddFunction("GetMaxNum", new GridFormulaEngine.LibraryFunction(myMaxNum));
// Custom function to be added to the library.
public string myMaxNum(string Args)
{
    GridFormulaCellModel myModel = this.gridControl1.CellModels["FormulaCell"] as GridFormulaCellModel;
    GridFormulaEngine engine = myModel.Engine;
    // Perform the required operations.
    int a, b, c;
    string[] coll = Args.Split(new char[] { ',' });
    a = Convert.ToInt32(coll[0]);
    b = Convert.ToInt32(coll[1]);
    c = Convert.ToInt32(coll[2]);
    int big = (a > b ? a : b);
    int bigger = (big > c ? big : c);
    // Make sure to define the custom function with string return type.
    return bigger.ToString();
}

Dim myModel As GridFormulaCellModel = TryCast(Me.gridControl1.CellModels("FormulaCell"), GridFormulaCellModel)
Dim calculateEngine As New GridFormulaEngine(Me.gridControl1.Model)
' Add the custom-function to the library functions.
myModel.Engine.AddFunction("GetMaxNum", New GridFormulaEngine.LibraryFunction(myMaxNum))
' Custom function to be added to the library.
Public Function myMaxNum(ByVal Args As String) As String
   Dim myModel As GridFormulaCellModel = TryCast(Me.gridControl1.CellModels("FormulaCell"), GridFormulaCellModel)
   Dim engine As GridFormulaEngine = myModel.Engine
   ' Perform the required operations.
   Dim a, b, c As Integer
   Dim coll() As String = Args.Split(New Char() { ","c })
   a = Convert.ToInt32(coll(0))
   b = Convert.ToInt32(coll(1))
   c = Convert.ToInt32(coll(2))
   Dim big As Integer = (If(a > b, a, b))
   Dim bigger As Integer = (If(big > c, big, c))
   ' Make sure to define the custom function with string return type.
   Return bigger.ToString()
End Function

AddNamedRange(String, String)

Adds a named range to the namedranges collection.

Declaration

public bool AddNamedRange(string name, string range)

Parameters

Type	Name	Description
System.String	name	The name of the range to be added.
System.String	range	The range to be added.

Returns

Type	Description
System.Boolean	True if successfully added, False otherwise.

Remarks

The range should be a string such as A4:C8.

AdjustNameRangesForSize()

Orders a namedrange collection according to string length.

Declaration

public void AdjustNameRangesForSize()

Remarks

The GridFormulaEngine needs an ordered list of named ranges to be able to properly parse named ranges. If you manually add named ranges to namedranges, then you should call this method afterwards.

AdjustReferences(String, Int32, Int32)

Helper method for adjusting formulas.

Declaration

public string AdjustReferences(string origText, int rowOffset, int colOffset)

Parameters

Type	Name	Description
System.String	origText	Valid unparsed formula string.
System.Int32	rowOffset	Row offset adjusmtent to be made to the origText.
System.Int32	colOffset	Column offset adjustment to be made to the origText

Returns

Type	Description
System.String	Unparsed formula string derived from origText by adjusting the row and column references.

Remarks

For example, calling AdjustReferences("=A4+C4", 2, 1) returns the string "=B6+D6". This is a helper method that is used to adjust formula references for inserted and deleted rows and columns. Normally, you would not need this method unless you are managing formulas outside the GridControl as in a virtual GridControl or a GridDataBoundGrid. This AdjustReferences implementation does not support updating references with sheet names within the formulas.

AdjustReferences(String, Int32, Int32, String, String)

Helper method for adjusting formulas.

Declaration

public string AdjustReferences(string origText, int rowOffset, int colOffset, string sheetNameWhereCopied, string currentSheetName)

Parameters

Type	Name	Description
System.String	origText	Valid unparsed formula string.
System.Int32	rowOffset	Row offset adjusmtent to be made to the origText.
System.Int32	colOffset	Column offset adjustment to be made to the origText
System.String	sheetNameWhereCopied	The name of the sheet where the copy took place.
System.String	currentSheetName	The name of the sheet where the cell holding origText is located.

Returns

Type	Description
System.String	Unparsed formula string derived from origText by adjusting the row and column references.

Remarks

This AdjustReferences implementation does support updating references with sheet names within the formulas.

BaseToBase(String, Int32, Int32)

Calculates the Output to the concerned base.

Declaration

public string BaseToBase(string argList, int from, int to)

Parameters

Type	Name	Description
System.String	argList	Data to be converted.
System.Int32	from	Base of the Given Data
System.Int32	to	Base to be obtained.

Returns

Type	Description
System.String	The data concerning to the base in 'to' parameter

besseli0(Double)

Used to calcualte the besseli0 function

Declaration

public static double besseli0(double x)

Parameters

Type	Name	Description
System.Double	x	Represents the double value

Returns

Type	Description
System.Double	Returns the result of besseli0 calculation

besseli1(Double)

Used to calculate the besseli1 function

Declaration

public static double besseli1(double x)

Parameters

Type	Name	Description
System.Double	x	Represents the double value

Returns

Type	Description
System.Double	Returns the result of besseli1 calculation

besselk0(Double)

Used to calculate the value of besselk0 function

Declaration

public static double besselk0(double x)

Parameters

Type	Name	Description
System.Double	x	Represents the double value

Returns

Type	Description
System.Double	Returns the value of besselK0 function.

besselk1(Double)

Used to calculate the value of besselk1 function

Declaration

public static double besselk1(double x)

Parameters

Type	Name	Description
System.Double	x	Represents the double values

Returns

Type	Description
System.Double	Returns the value of besselK1 function.

BetaCumulativeDist(Double, Double, Double)

Returns the Beta cumulative density function.

Declaration

public double BetaCumulativeDist(double x, double a, double b)

Parameters

Type	Name	Description
System.Double	x	Value of the random variable for which the CDF is beign evaluated. x is between 0 and 1.
System.Double	a	First shape parameter.
System.Double	b	Second shape parameter.

Returns

Type
System.Double

ChangeGridSheetName(String, String, GridModel)

Changes a sheet name that was previously registered using RegisterGridAsSheet(String, GridModel, Int32). This method iterates through all the cells in all the sheets in the sheet family, swapping all occurrences of the oldName in any formula with the newName.

Declaration

public static bool ChangeGridSheetName(string oldName, string newName, GridModel grid)

Parameters

Type	Name	Description
System.String	oldName	The old sheet name.
System.String	newName	The new sheet name.
GridModel	grid	True if the sheet was successfully renamed. If false returns, check whether the sheet family already contains the new name.

Returns

Type	Description
System.Boolean	returns boolean value

ChiSquaredProbabilityDensityFunction(Double, Int32)

Chi-squared probability density function.

Declaration

public double ChiSquaredProbabilityDensityFunction(double x, int k)

Parameters

Type	Name	Description
System.Double	x	The value at which the PDF is evaluated.
System.Int32	k	Degress of freedom, or number independent standard normal distributions.

Returns

Type
System.Double

ColIndex(String)

Returns a column index from a cell reference.

Declaration

public int ColIndex(string s)

Parameters

Type	Name	Description
System.String	s	String holding a cell reference such as C21 or AB11.

Returns

Type	Description
System.Int32	An integer with the corresponding column number.

Combinations(Int32, Int32)

Returns the number of possible combinations of k objects from a set of n object. The order of the chosen objects does not matter.

Declaration

public static double Combinations(int n, int k)

Parameters

Type	Name	Description
System.Int32	n	Number of objects
System.Int32	k	Number of objects chosen

Returns

Type	Description
System.Double	Returns the rounded combination values.

ComputeAbs(String)

Computes the absolute value of the argument.

Declaration

public string ComputeAbs(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the absolute value of the argument.

ComputeACCRINT(String)

Calculates the accrued interest of a security in the case of periodic payments.

Declaration

public string ComputeACCRINT(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Accrued interest

ComputeAcos(String)

Computes angle whose cosine is the argument.

Declaration

public string ComputeAcos(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding angle whose cosine is the argument.

ComputeAcosh(String)

The inverse of Cosh.

Declaration

public string ComputeAcosh(string args)

Parameters

Type	Name	Description
System.String	args	Value >= 1.

Returns

Type	Description
System.String	returns ACosh(value).

ComputeAcot(String)

Returns the arccotangent of a number.

Declaration

public string ComputeAcot(string argList)

Parameters

Type	Name	Description
System.String	argList	A cell reference or number

Returns

Type	Description
System.String	A string containing the arccotangent of a number

ComputeAcoth(String)

Returns the hyperbolic arccotangent of a number.

Declaration

public string ComputeAcoth(string argList)

Parameters

Type	Name	Description
System.String	argList	A cell reference or number

Returns

Type	Description
System.String	A string containing the hyperbolic arccotangent of a number

ComputeAcsch(String)

Returns the archyperbolic cosecant of an angle.

Declaration

public string ComputeAcsch(string argList)

Parameters

Type	Name	Description
System.String	argList	A cell reference or a cell or a number

Returns

Type	Description
System.String	A string containing the archyperbolic cosecant of an angle

ComputeAddress(String)

this function used to obtain the address of a cell in a worksheet, given specified row and column numbers

Declaration

public string ComputeAddress(string argList)

Parameters

Type	Name	Description
System.String	argList	The argList contain the row and column postion and type of reference

Returns

Type	Description
System.String	Address of the given row and column

ComputeAnd(String)

Returns the AND of all values treated as logical values listed in the argument.

Declaration

public string ComputeAnd(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers. Each item in the list is considered True if it is nonzero, and False if it is zero.

Returns

Type	Description
System.String	A string holding the AND of all values listed in the argument.

ComputeArabic(String)

Returns the Arabic value of Raman numeric

Declaration

public string ComputeArabic(string arg)

Parameters

Type	Name	Description
System.String	arg

Returns

Type
System.String

ComputeAreas(String)

Returns the area of the passed in cell reference range

Declaration

public string ComputeAreas(string arg)

Parameters

Type	Name	Description
System.String	arg	Contains one argument - reference

Returns

Type	Description
System.String	area of the passed in cell reference.

ComputeAsc(String)

Used to calculate the value of ComputeAsc function

Declaration

public string ComputeAsc(string arg)

Parameters

Type	Name	Description
System.String	arg	Represents the string values

Returns

Type
System.String

ComputeAsech(String)

Returns the archyperbolic secant of an angle.

Declaration

public string ComputeAsech(string argList)

Parameters

Type	Name	Description
System.String	argList	A cell reference or a number

Returns

Type	Description
System.String	A string containing the archyperbolic secant of an angle

ComputeAsin(String)

Computes angle whose sine is the argument.

Declaration

public string ComputeAsin(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding angle whose sine is the argument.

ComputeAsinh(String)

The inverse of Sinh.

Declaration

public string ComputeAsinh(string args)

Parameters

Type	Name	Description
System.String	args	The Value.

Returns

Type	Description
System.String	returns ASinh(value).

ComputeAtan(String)

Computes angle whose tangent is the argument.

Declaration

public string ComputeAtan(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the tangent of the argument.

ComputeAtan2(String)

The ArcTangent of the x and y values.

Declaration

public string ComputeAtan2(string argList)

Parameters

Type	Name	Description
System.String	argList	x_value and y_value.

Returns

Type	Description
System.String	Angle whose tangent is y_value/x_value.

ComputeAtanh(String)

The inverse of Tanh.

Declaration

public string ComputeAtanh(string args)

Parameters

Type	Name	Description
System.String	args	|Value| < 1.

Returns

Type	Description
System.String	returns ATanh(value).

ComputeAvedev(String)

Returns the average deviation of all values listed in the argument.

Declaration

public string ComputeAvedev(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the average deviation of all values listed in the argument.

ComputeAveragea(String)

Returns the simple average of all values (including text) listed in the argument.

Declaration

public string ComputeAveragea(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the simple average of all values listed in the argument.

ComputeAverageIF(String)

Returns the average of all the cells in a range which is statisfy the given single criteria

Declaration

public string ComputeAverageIF(string argList)

Parameters

Type	Name	Description
System.String	argList	range of cells, criteria, average_range

Returns

Type	Description
System.String	returns the average value of the cells.

ComputeAverageIFS(String)

Returns the average of all the cells in a range which is statisfy the given multible criteria

Declaration

public string ComputeAverageIFS(string argList)

Parameters

Type	Name	Description
System.String	argList	range of cells, criteria1, average_range1,...

Returns

Type	Description
System.String	returns the average value of the cells.

ComputeAvg(String)

Returns the simple average of all values listed in the argument.

Declaration

public string ComputeAvg(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the simple average of all values listed in the argument.

ComputeBahtText(String)

Returns the row index of the passed in cell reference.

Declaration

public string ComputeBahtText(string arg)

Parameters

Type	Name	Description
System.String	arg	Contains zero or one argument. If no argument is passed, returns the row index of the location of this Row function cell, otherwise returns the row index of the passed in cell reference.

Returns

Type	Description
System.String	The row index.

Remarks

This method doesn't return an array of row numbers as the array formula entry is not supported in engine. It is another usecase of this library function.

ComputeBase(String)

Used to calculate the value of ComputeBase function

Declaration

public string ComputeBase(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values

Returns

Type
System.String

ComputeBesselI(String)

Used to calculate the value of ComputeBesselI function

Declaration

public string ComputeBesselI(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values

Returns

Type	Description
System.String	Returns the result of ComputeBesselI calculation

ComputeBesselJ(String)

Returns the BesselJ function of order n of the specified number.

Declaration

public string ComputeBesselJ(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Number

Returns

Type	Description
System.String	The BesselJ of the Number.

ComputebesselK(String)

Used to calculate the value of ComputebesselK function

Declaration

public string ComputebesselK(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values used in the function

Returns

Type	Description
System.String	Returns the result of ComputebesselK function.

ComputeBesselY(String)

Returns the BesselY function of order n of the specified number.

Declaration

public string ComputeBesselY(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Number

Returns

Type	Description
System.String	The BesselY of the Number.

ComputeBetaDist(String)

Returns the beta distribution.

Declaration

public string ComputeBetaDist(string argList)

Parameters

Type	Name	Description
System.String	argList	x, degreesfreedom1, degreesfreedom2.

Returns

Type	Description
System.String	Returns the beta distribution.

ComputeBigMul(String)

Returns the full product of two 32-bit numbers.

Declaration

public string ComputeBigMul(string argList)

Parameters

Type	Name	Description
System.String	argList	The two 32 bit numbers.

Returns

Type	Description
System.String	A string containing the product of two 32 bit numbers.

ComputeBin2Dec(String)

Computes the Decimal Number for the given binary NUmber.

Declaration

public string ComputeBin2Dec(string argList)

Parameters

Type	Name	Description
System.String	argList	Input BinaryNumber

Returns

Type	Description
System.String	The resultant Decimal Number

ComputeBin2Hex(String)

Computes the HexaDecimal Number for the given binary NUmber.

Declaration

public string ComputeBin2Hex(string argList)

Parameters

Type	Name	Description
System.String	argList	Input BinaryNumber

Returns

Type	Description
System.String	The resultant HexaDecimal Number

ComputeBin2Oct(String)

Computes the Octal Number for the given binary NUmber.

Declaration

public string ComputeBin2Oct(string argList)

Parameters

Type	Name	Description
System.String	argList	Input BinaryNumber

Returns

Type	Description
System.String	The resultant Octal Number

ComputeBinomdist(String)

Returns the binomial distribution.

Declaration

public string ComputeBinomdist(string argList)

Parameters

Type	Name	Description
System.String	argList	Number of successes, number of trials, probability, cumulative.

Returns

Type	Description
System.String	Returns binomial distribution.

ComputeBinomOdist(String)

Returns the binomial distribution.

Declaration

public string ComputeBinomOdist(string argList)

Parameters

Type	Name	Description
System.String	argList	Number of successes, number of trials, probability, cumulative.

Returns

Type	Description
System.String	The binomial distribution.

ComputeBinomOInv(String)

Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value.

Declaration

public string ComputeBinomOInv(string argList)

Parameters

Type	Name	Description
System.String	argList	Number of trials, probability, alpha.

Returns

Type	Description
System.String	Returns the critical value.

ComputeBitAnd(String)

Computes the Bit AND of the given two numbers.

Declaration

public string ComputeBitAnd(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Numbersfor which the AND operations has to be performed.

Returns

Type	Description
System.String	Bit AND value of the given two numbers.

ComputeBitLShift(String)

Computes the Bit Left Shift of the given number.

Declaration

public string ComputeBitLShift(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Numbersfor which the OR operations has to be performed.

Returns

Type	Description
System.String	Bit Left Shift value of the given number.

ComputeBitOr(String)

Computes the Bit OR of the given two numbers.

Declaration

public string ComputeBitOr(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Numbersfor which the OR operations has to be performed.

Returns

Type	Description
System.String	Bit OR value of the given two numbers.

ComputeBitRShift(String)

Computes the Bit Right Shift of the given number.

Declaration

public string ComputeBitRShift(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Numbersfor which the Bit Right Shift operations has to be performed.

Returns

Type	Description
System.String	Bit Right Shift value of the given number.

ComputeBitXor(String)

Computes the Bit XoR of the given two numbers.

Declaration

public string ComputeBitXor(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Numbersfor which the OR operations has to be performed.

Returns

Type	Description
System.String	Bit OR value of the given two numbers.

ComputeCeiling(String)

Computes the smallest whole number greater than or equal to the argument.

Declaration

public string ComputeCeiling(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the smallest whole number greater than or equal to the argument.

ComputeCeilingMath(String)

Returns the RoundUp of the given number to the given significance

Declaration

public string ComputeCeilingMath(string args)

Parameters

Type	Name	Description
System.String	args	Number, significance, mode

Returns

Type	Description
System.String	RoundUp number

ComputeCell(String)

Used to calculate the value of ComputeCell function

Declaration

public string ComputeCell(string arg)

Parameters

Type	Name	Description
System.String	arg	Represents the string values used in the function

Returns

Type
System.String

ComputeChar(String)

Returns the character whose number code is specified in the argument.

Declaration

public string ComputeChar(string arg)

Parameters

Type	Name	Description
System.String	arg	The number used to retrieve the character.

Returns

Type	Description
System.String	The character string.

ComputeChidist(String)

Returns the chi-squared distribution.

Declaration

public string ComputeChidist(string argList)

Parameters

Type	Name	Description
System.String	argList	X degrees of freedom.

Returns

Type	Description
System.String	Returns chi-squared distribution.

ComputeChiinv(String)

Returns the inverse of the chi-squared distribution.

Declaration

public string ComputeChiinv(string argList)

Parameters

Type	Name	Description
System.String	argList	X degrees of freedom.

Returns

Type	Description
System.String	Returns inverse of the chi-squared distribution.

ComputeChisqOdist(String)

Returns the chi-squared distribution.

Declaration

public string ComputeChisqOdist(string argList)

Parameters

Type	Name	Description
System.String	argList	x, degrees of freedom.

Returns

Type	Description
System.String	The chi-squared distribution.

ComputeChisqOdistORt(String)

Returns the chi-squared distribution.

Declaration

public string ComputeChisqOdistORt(string argList)

Parameters

Type	Name	Description
System.String	argList	x, degrees of freedom.

Returns

Type	Description
System.String	The chi-squared distribution.

ComputeChisqOinv(String)

Returns the inverse of the chi-squared distribution.

Declaration

public string ComputeChisqOinv(string argList)

Parameters

Type	Name	Description
System.String	argList	x, degrees of freedom.

Returns

Type	Description
System.String	The inverse of the chi-squared distribution.

ComputeChisqOinvORt(String)

Returns the inverse of the chi-squared distribution.

Declaration

public string ComputeChisqOinvORt(string argList)

Parameters

Type	Name	Description
System.String	argList	x, degrees of freedom.

Returns

Type	Description
System.String	The inverse of the chi-squared distribution.

ComputeChisqOTest(String)

Returns the Chi Test for independence.

Declaration

public string ComputeChisqOTest(string range)

Parameters

Type	Name	Description
System.String	range	Actual_range, expected_range.

Returns

Type	Description
System.String	Result of Chi Test: y-intercept.

ComputeChitest(String)

Returns the Chi Test for independence.

Declaration

public string ComputeChitest(string range)

Parameters

Type	Name	Description
System.String	range	Actual_range, expected_range.

Returns

Type	Description
System.String	returns y-intercept.

ComputeClean(String)

Retuns the text removing the first 32 nonprintable characters(ranging from 0 to 31) in 7-bit ASCII code.

Declaration

public string ComputeClean(string arg)

Parameters

Type	Name	Description
System.String	arg	Text or range holding text including nonprintable characters

Returns

Type	Description
System.String	Text without nonprintable characters(first 32)

ComputeCode(String)

Return the numeric code for first char of text

Declaration

public string ComputeCode(string argList)

Parameters

Type	Name	Description
System.String	argList	text

Returns

Type	Description
System.String	numeric code

ComputeColumns(String)

Returns the number of columns of the passed in cell reference.

Declaration

public string ComputeColumns(string arg)

Parameters

Type	Name	Description
System.String	arg	Contains one argument - reference

Returns

Type	Description
System.String	number of columns.

ComputeCombin(String)

The number of combinations of a given number of items.

Declaration

public string ComputeCombin(string argList)

Parameters

Type	Name	Description
System.String	argList	number, number_items.

Returns

Type	Description
System.String	The number of combinations.

ComputeCombinA(String)

Used to calculate the value of ComputeCombinA function

Declaration

public string ComputeCombinA(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values used in the function

Returns

Type
System.String

ComputeComplex(String)

Obtains the complex number for the given real and imaginary part.

Declaration

public string ComputeComplex(string argList)

Parameters

Type	Name	Description
System.String	argList	Given real and Imaginary part.

Returns

Type	Description
System.String	The complex number derived from the real and imaginary part.

ComputeConcatenate(String)

Returns a single character string.

Declaration

public string ComputeConcatenate(string range)

Parameters

Type	Name	Description
System.String	range	List of strings to be concatenated.

Returns

Type	Description
System.String	A single string.

ComputeConfidence(String)

Returns a confidence interval radius.

Declaration

public string ComputeConfidence(string argList)

Parameters

Type	Name	Description
System.String	argList	Alpha, standard deviation, size.

Returns

Type	Description
System.String	Returns x such that normal distribution at x is p.

Remarks

P should be between 0 and 1.

ComputeConfidenceOnorm(String)

Returns a confidence interval radius.

Declaration

public string ComputeConfidenceOnorm(string argList)

Parameters

Type	Name	Description
System.String	argList	Alpha, standard deviation, size.

Returns

Type	Description
System.String	Returns x such that normal distribution at x is p.

Remarks

P should be between 0 and 1.

ComputeConfidenceT(String)

Used to calculate the value of ComputeConfidenceT function

Declaration

public string ComputeConfidenceT(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values used in the function

Returns

Type
System.String

ComputeConversion(String)

Used to calculate the value of ComputeConversion function

Declaration

public string ComputeConversion(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values used in the function

Returns

Type	Description
System.String	Returns the result of compute conversion function.

ComputeCorrel(String)

Returns the correlation coefficient between the two sets of points.

Declaration

public string ComputeCorrel(string range)

Parameters

Type	Name	Description
System.String	range	Range1, range2.

Returns

Type	Description
System.String	Correlation coefficient.

ComputeCos(String)

Computes the cosine of the argument.

Declaration

public string ComputeCos(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the cosine of the argument.

ComputeCosh(String)

Computes the hyperbolic cosine of the argument.

Declaration

public string ComputeCosh(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the hyperbolic cosine of the argument.

ComputeCot(String)

Returns the hyperbolic cosine of a number.

Declaration

public string ComputeCot(string argList)

Parameters

Type	Name	Description
System.String	argList	A cell reference or a number

Returns

Type	Description
System.String	A string containing the hyperbolic cosine of a number

ComputeCoth(String)

Returns the cotangent of an angle.

Declaration

public string ComputeCoth(string argList)

Parameters

Type	Name	Description
System.String	argList	A cell reference or a number

Returns

Type	Description
System.String	A string containing the cotangent of an angle

ComputeCount(String)

Returns the count of all values (including text) listed in the argument evaluate to a number.

Declaration

public string ComputeCount(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the count of all numerical values listed in the argument.

ComputeCounta(String)

Returns the count of all values (including text) listed in the argument.

Declaration

public string ComputeCounta(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the count of all values listed in the argument.

ComputeCountblank(String)

Returns the count of blank cells listed in the argument.

Declaration

public string ComputeCountblank(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the count of blank cells listed in the argument.

ComputeCountif(String)

Counts the cells specified by some criteria.

Declaration

public string ComputeCountif(string argList)

Parameters

Type	Name	Description
System.String	argList	The criteria range, the criteria.

Returns

Type	Description
System.String	returns string to the cell count

ComputeCountifs(String)

Counts the cells specified by some criteria.

Declaration

public string ComputeCountifs(string argList)

Parameters

Type	Name	Description
System.String	argList	The criteria ranges and its criterias.

Returns

Type	Description
System.String	returns string to the cell count

ComputeCovar(String)

Returns the covariance between the two sets of points.

Declaration

public string ComputeCovar(string range)

Parameters

Type	Name	Description
System.String	range	Range1, range2.

Returns

Type	Description
System.String	returns Covariance.

ComputeCovarianceP(String)

Returns population covariance, the average of the products of deviations for each data point pair in two data sets.

Declaration

public string ComputeCovarianceP(string range)

Parameters

Type	Name	Description
System.String	range	range1, range2.

Returns

Type	Description
System.String	The covarianceP

ComputeCovarianceS(String)

Returns the sample covariance, the average of the products of deviations for each data point pair in two data sets.

Declaration

public string ComputeCovarianceS(string range)

Parameters

Type	Name	Description
System.String	range	range1, range2.

Returns

Type	Description
System.String	The covariances

ComputeCritbinom(String)

Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value.

Declaration

public string ComputeCritbinom(string argList)

Parameters

Type	Name	Description
System.String	argList	Number of trials, probability, alpha.

Returns

Type	Description
System.String	Returns the critcal value.

ComputeCsc(String)

Returns the cosecant of an angle

Declaration

public string ComputeCsc(string argList)

Parameters

Type	Name	Description
System.String	argList	a cell reference or number

Returns

Type	Description
System.String	A string containing the cosecant of an angle

ComputeCsch(String)

Returns the hyperbolic cosecant of an angle.

Declaration

public string ComputeCsch(string argList)

Parameters

Type	Name	Description
System.String	argList

Returns

Type	Description
System.String	A string containing the hyperbolic cosecant of an angle

ComputeCUMIPMT(String)

Returns the cumulative interest paid for an investment period with a constant interest rate.

Declaration

public string ComputeCUMIPMT(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Number of interest rate

ComputeCUMPRINC(String)

Returns the cumulative principal paid for an investment period with a constant interest rate.

Declaration

public string ComputeCUMPRINC(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Cumulative principal value

ComputeDate(String)

Returns the number of days since 01 Jan 1900.

Declaration

public string ComputeDate(string argList)

Parameters

Type	Name	Description
System.String	argList	Year, month, and day.

Returns

Type	Description
System.String	Number of days.

ComputeDatevalue(String)

Returns the number of days since 01 Jan 1900.

Declaration

public string ComputeDatevalue(string argList)

Parameters

Type	Name	Description
System.String	argList	Text containing a date.

Returns

Type	Description
System.String	Number of days.

ComputeDAverage(String)

Averages the values in a field (column) of records in a list or database that match conditions you specify.

Declaration

public string ComputeDAverage(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeDay(String)

Returns the day of the serial number date.

Declaration

public string ComputeDay(string argList)

Parameters

Type	Name	Description
System.String	argList	Serial number date.

Returns

Type	Description
System.String	returns Day.

ComputeDays(String)

Returns the number of days between two dates.

Declaration

public string ComputeDays(string argList)

Parameters

Type	Name	Description
System.String	argList	startDate, endDate

Returns

Type	Description
System.String	Returns the number of days

ComputeDays360(String)

Number of days between 2 dates using 360 day year.

Declaration

public string ComputeDays360(string argList)

Parameters

Type	Name	Description
System.String	argList	Serial number date1, serial number date1, and method.

Returns

Type	Description
System.String	Days between the dates.

ComputeDb(String)

Computes the declining balance of an asset.

Declaration

public string ComputeDb(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the initial cost, salvage value, life of asset, period of calculation, and months in initial year.

Returns

Type	Description
System.String	returns declining balance of an asset.

ComputeDCount(String)

Returns the amount received at maturity for a fully invested security.

Declaration

public string ComputeDCount(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeDCountA(String)

Counts the nonblank cells in a field (column) of records in a list or database that match conditions that you specify.

Declaration

public string ComputeDCountA(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeDdb(String)

Computes the double declining balance of an asset.

Declaration

public string ComputeDdb(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the initial cost, salvage value, life of asset, period of calculation, factor.

Returns

Type	Description
System.String	returns double declining balance of an asset

ComputeDec2Bin(String)

Computes the Binary value for the given Decimal Number.

Declaration

public string ComputeDec2Bin(string argList)

Parameters

Type	Name	Description
System.String	argList	Data to be converted.

Returns

Type	Description
System.String	Returns the calculated Binary value.

ComputeDec2Hex(String)

Computes the Hexadecimal value for the given Decimal Number.

Declaration

public string ComputeDec2Hex(string argList)

Parameters

Type	Name	Description
System.String	argList	Data to be converted.

Returns

Type	Description
System.String	Returns the calculated Hexadecimal value.

ComputeDec2Oct(String)

Computes the Octal value for the given Decimal Number.

Declaration

public string ComputeDec2Oct(string argList)

Parameters

Type	Name	Description
System.String	argList	data to be converted.

Returns

Type	Description
System.String	Returns the calculated Octal value.

ComputeDecimal(String)

Returns the decimal number of the given text to the given base.

Declaration

public string ComputeDecimal(string argList)

Parameters

Type	Name	Description
System.String	argList	text,base

Returns

Type	Description
System.String	Decimal number.

ComputeDegrees(String)

Converts radians into degrees.

Declaration

public string ComputeDegrees(string args)

Parameters

Type	Name	Description
System.String	args	Value in radians.

Returns

Type	Description
System.String	returns Degrees.

ComputeDelta(String)

Compares the given two values

Declaration

public string ComputeDelta(string argList)

Parameters

Type	Name	Description
System.String	argList	Two Numbers to be compared.

Returns

Type	Description
System.String	Returns the result of the comparision in the form of 0 or 1

ComputeDevsq(String)

Returns the sum of the squares of the mean deviations.

Declaration

public string ComputeDevsq(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	Sum of the squares of the mean deviation.

ComputeDGet(String)

Extracts a single value from a column of a list or database that matches conditions that you specify.

Declaration

public string ComputeDGet(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeDisc(String)

Returns the discount rate for a security.

Declaration

public string ComputeDisc(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Rate of Discount

ComputeDivRem(String)

Used to calculate the value of ComputeDivRem function

Declaration

public string ComputeDivRem(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string value used in the function

Returns

Type	Description
System.String	A string containing the remainder in an output parameter..

ComputeDMax(String)

Returns the largest number in a field (column) of records in a list or database that matches conditions you that specify.

Declaration

public string ComputeDMax(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeDMin(String)

Returns the smallest number in a field (column) of records in a list or database that matches conditions that you specify.

Declaration

public string ComputeDMin(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeDollar(String)

Converts a number to text using currency format.

Declaration

public string ComputeDollar(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits.

Returns

Type	Description
System.String	Currency format string.

ComputeDollarDe(String)

Converts a number to text using currency format.

Declaration

public string ComputeDollarDe(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits.

Returns

Type	Description
System.String	Currency format string.

ComputeDollarFr(String)

Converts a number to text using currency format.

Declaration

public string ComputeDollarFr(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits.

Returns

Type	Description
System.String	Currency format string.

ComputeDProduct(String)

Returns the smallest number in a field (column) of records in a list or database that matches conditions that you specify.

Declaration

public string ComputeDProduct(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeDStdev(String)

Estimates the standard deviation of a population based on a sample by using the numbers in a field (column) of records in a list or database that match conditions that you specify.

Declaration

public string ComputeDStdev(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeDStdevp(String)

Calculates the standard deviation of a population based on the entire population by using the numbers in a field (column) of records in a list or database that match conditions that you specify.

Declaration

public string ComputeDStdevp(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeDSum(String)

Adds the numbers in a field (column) of records in a list or database that match conditions that you specify

Declaration

public string ComputeDSum(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeDuration(String)

Returns the weighted average of the present value of the cash flows

Declaration

public string ComputeDuration(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Number of years

ComputedValue(String)

Computes the value of a parsed formula.

Declaration

public string ComputedValue(string formula)

Parameters

Type	Name	Description
System.String	formula	The formula to be computed.

Returns

Type	Description
System.String	A string holding the computed value.

Remarks

The string passed into ComputedValue must have been parsed using the Parse method. Before calling the method, you should set FormulaContextCell to properly reflect which cell owns this formula.

ComputeDVar(String)

Estimates the variance of a population based on a sample by using the numbers in a field (column) of records in a list or database that match conditions that you specify.

Declaration

public string ComputeDVar(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeDVarp(String)

Calculates the variance of a population based on the entire population by using the numbers in a field (column) of records in a list or database that match conditions that you specify.

Declaration

public string ComputeDVarp(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeEDate(String)

returns the date of given date after the specific month

Declaration

public string ComputeEDate(string argList)

Parameters

Type	Name	Description
System.String	argList	startDate, months

Returns

Type	Description
System.String	returns the date

ComputeEncodeURL(String)

Returns the encode url of the given text

Declaration

public string ComputeEncodeURL(string argList)

Parameters

Type	Name	Description
System.String	argList	text

Returns

Type	Description
System.String	returns the EncodeURL

ComputeEOMonth(String)

Returns the last date of the date after the specific month of given date.

Declaration

public string ComputeEOMonth(string argList)

Parameters

Type	Name	Description
System.String	argList	startDate, month

Returns

Type	Description
System.String	return the date.

ComputeErf(String)

Returns the error function .

Declaration

public string ComputeErf(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Number

Returns

Type	Description
System.String	The error function.

ComputeErfCPrecise(String)

Returns the Complement of error function .

Declaration

public string ComputeErfCPrecise(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Number

Returns

Type	Description
System.String	The Complement of error function.

ComputeErfPrecise(String)

Returns the error function .

Declaration

public string ComputeErfPrecise(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Number

Returns

Type	Description
System.String	The error function.

ComputeErrorType(String)

Returns a number corresponding to the predefined error values(#NULL!, #VALUE!, #REF!, #NAME?, #NUM!, #N/A, "#GETTING_DATA). Returns #N/A if not or any value enclosed within double quotes.

Declaration

public string ComputeErrorType(string args)

Parameters

Type	Name	Description
System.String	args

Returns

Type
System.String

ComputeEven(String)

Rounds up to larger in magnitude even number.

Declaration

public string ComputeEven(string args)

Parameters

Type	Name	Description
System.String	args	Number to be rounded.

Returns

Type	Description
System.String	Rounded even value.

ComputeExp(String)

Computes e raised to the value of the argument.

Declaration

public string ComputeExp(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the e raised to the value of the argument.

ComputeExpondist(String)

Returns the exponential distribution.

Declaration

public string ComputeExpondist(string argList)

Parameters

Type	Name	Description
System.String	argList	X, lambda, cumulative.

Returns

Type	Description
System.String	Returns exponential distribution.

Remarks

Cumulative should be either True if you want to return the value of the distribution function or False if you want to return the value of the density function.

ComputeExponODist(String)

Returns the exponential distribution.

Declaration

public string ComputeExponODist(string argList)

Parameters

Type	Name	Description
System.String	argList	x, lambda, cumulative.

Returns

Type	Description
System.String	The exponential distribution.

Remarks

Cumulative should be either True if you want to return the value of the distribution function or False if you want to return the value of the density function.

ComputeFact(String)

Factorial of a given number.

Declaration

public string ComputeFact(string args)

Parameters

Type	Name	Description
System.String	args	The x args.

Returns

Type	Description
System.String	returns x!.

ComputeFactdouble(String)

Returns the Double Factorial value for given number

Declaration

public string ComputeFactdouble(string args)

Parameters

Type	Name	Description
System.String	args	number to find FactDouble

Returns

Type	Description
System.String	FactDouble of given number

ComputeFalse(String)

Returns the logical value False.

Declaration

public string ComputeFalse(string empty)

Parameters

Type	Name	Description
System.String	empty

Returns

Type	Description
System.String	Logical False value string.

ComputeFdist(String)

Returns the F (Fisher) probability distribution.

Declaration

public string ComputeFdist(string argList)

Parameters

Type	Name	Description
System.String	argList	X, degreesfreedom1, degreesfreedom2.

Returns

Type	Description
System.String	Returns the F probability distribution.

ComputeFilterXml(String)

Used to calculate the value of ComputeFilterXml function

Declaration

public string ComputeFilterXml(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values used in the function

Returns

Type
System.String

ComputeFindB(String)

Finds the first occurrence of one string in another string.

Declaration

public string ComputeFindB(string arg)

Parameters

Type	Name	Description
System.String	arg	Conatins two or three arguments. The first argument is the string to find. The second string is the string that is being searched. The third argument is the start location in the second string for the search.

Returns

Type	Description
System.String	The location of the found string.

ComputeFinv(String)

Returns the inverse of F distribution.

Declaration

public string ComputeFinv(string argList)

Parameters

Type	Name	Description
System.String	argList	P, degreesfreedom1, degreesfreedom2.

Returns

Type	Description
System.String	Returns x such that F distribution at x is p.

Remarks

P should be between 0 and 1.

ComputeFisher(String)

Returns the Fisher transformation of the input variable.

Declaration

public string ComputeFisher(string argList)

Parameters

Type	Name	Description
System.String	argList	Input variable x.

Returns

Type	Description
System.String	Fisher transformation of x.

Remarks

X should be between -1 and 1.

ComputeFisherinv(String)

Returns the inverse of Fisher transformation.

Declaration

public string ComputeFisherinv(string argList)

Parameters

Type	Name	Description
System.String	argList	Input variable y.

Returns

Type	Description
System.String	The value x such that the Fisher transformation y is x.

ComputeFixed(String)

Rounds a number to the specified number of decimals, formats the number in decimal format using a period and commas, and return the result as text.

Declaration

public string ComputeFixed(string args)

Parameters

Type	Name	Description
System.String	args	Number, number of digits, a flag that prevents from include commas in the returned text.

Returns

Type	Description
System.String	Formatted number as string.

ComputeFloor(String)

Computes the largest whole number less than or equal to the argument.

Declaration

public string ComputeFloor(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the largest whole number less than or equal to the argument.

ComputeFOdist(String)

Returns the F probability distribution.

Declaration

public string ComputeFOdist(string argList)

Parameters

Type	Name	Description
System.String	argList	x, degreesfreedom1, degreesfreedom2.

Returns

Type	Description
System.String	Returns the F probability distribution.

ComputeFOdistORt(String)

Returns the F (Fisher) probability distribution.

Declaration

public string ComputeFOdistORt(string argList)

Parameters

Type	Name	Description
System.String	argList	x, degreesfreedom1, degreesfreedom2.

Returns

Type	Description
System.String	Returns the F probability distribution.

ComputeFOinv(String)

Returns the inverse of F distribution.

Declaration

public string ComputeFOinv(string argList)

Parameters

Type	Name	Description
System.String	argList	p, degreesfreedom1, degreesfreedom2.

Returns

Type	Description
System.String	Returns x such that F distribution at x is p.

Remarks

P should be between 0 and 1.

ComputeFOinvORt(String)

Returns the inverse of F distribution.

Declaration

public string ComputeFOinvORt(string argList)

Parameters

Type	Name	Description
System.String	argList	p, degreesfreedom1, degreesfreedom2.

Returns

Type	Description
System.String	Returns x such that F distribution at x is p.

Remarks

P should be between 0 and 1.

ComputeForecast(String)

Returns a forecasted value based on two sets of points using Least Square Fit regression.

Declaration

public string ComputeForecast(string range)

Parameters

Type	Name	Description
System.String	range	X, rangex, rangey.

Returns

Type	Description
System.String	returns Forecasted.

ComputeFormulaText(String)

Used to calculate the value of ComputeFormulaText function

Declaration

public string ComputeFormulaText(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values used in the function

Returns

Type
System.String

Examples

This example hows how to compute the given formula string in a given formula string.

GridFormulaEngine calculateEngine = new GridFormulaEngine(this.gridControl1.Model);
string myFormula = "(7+6)*2";
// Parses the given string.
string parsedValue = calculateEngine.Parse(myFormula);
// Computes the resultant value.
string computedValue = calculateEngine.ComputeFormulaText(parsedValue);
Console.WriteLine("The computed value is  " + computedValue);

Dim calculateEngine As New GridFormulaEngine(Me.gridControl1.Model)
Dim myFormula As String = "(7+6)*2"
' Parses the given string
Dim parsedValue As String = calculateEngine.Parse(myFormula)
' Computes the resultant value.
Dim computedValue As String = calculateEngine.ComputeFormulaText(parsedValue)
Console.WriteLine("The computed value is  " & computedValue)

ComputeFv(String)

Computes the future value of an investment.

Declaration

public string ComputeFv(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the rate as percentage per period, number of periods, payment per period, present value, and payment type (0 = end of period, 1 = start of period).

Returns

Type	Description
System.String	returns future value of an investment

ComputeFvschedule(String)

Returns the future value of an initial principal after applying a series of compound interest rates.

Declaration

public string ComputeFvschedule(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Number of future value

ComputeGammadist(String)

Returns the gamma distribution.

Declaration

public string ComputeGammadist(string argList)

Parameters

Type	Name	Description
System.String	argList	X, alpha, beta, cumulative.

Returns

Type	Description
System.String	Returns gamma distribution.

Remarks

X, alpha and beta should be positive real numbers. Cumulative should be either True if you want to return the value of the distribution function, or False if you want to return the value of the density function. The distribution value is computed interactively using Trapezoidal Rule to six to seven significant digits or 20 iteration maximum.

ComputeGammainv(String)

Returns the inverse of gamma distribution.

Declaration

public string ComputeGammainv(string argList)

Parameters

Type	Name	Description
System.String	argList	P, alpha, beta

Returns

Type	Description
System.String	Returns x such that gamma distribution at x is p.

Remarks

P, alpha and beta should be positive real numbers, with p between 0 and 1.

ComputeGammaln(String)

Returns the natural logarithm of the gamma function.

Declaration

public string ComputeGammaln(string argList)

Parameters

Type	Name	Description
System.String	argList	The value to be evaluated.

Returns

Type	Description
System.String	Returns natural logarithm of gamma function.

ComputeGammaln0Precise(String)

Returns the natural logarithm of the gamma function.

Declaration

public string ComputeGammaln0Precise(string argList)

Parameters

Type	Name	Description
System.String	argList	The value to be evaluated.

Returns

Type	Description
System.String	The natural logarithm of the gamma function.

ComputeGammaOdist(String)

Returns the gamma distribution.

Declaration

public string ComputeGammaOdist(string argList)

Parameters

Type	Name	Description
System.String	argList	X, alpha, beta, cumulative.

Returns

Type	Description
System.String	The gamma distribution.

Remarks

X, alpha, and beta should be positive real numbers. Cumulative should be either True if you want to return the value of the distribution function or False if you want to return the value of the density function. The distribution value is computed interactively using Trapezoidal Rule to six to seven significant digits or 20 iteration maximum.

ComputeGammaOinv(String)

Returns the inverse of gamma distribution.

Declaration

public string ComputeGammaOinv(string argList)

Parameters

Type	Name	Description
System.String	argList	p, alpha, beta

Returns

Type	Description
System.String	Returns x such that gamma distribution at x is p.

Remarks

P, alpha, and beta should be positive real numbers, with p between 0 and 1.

ComputeGcd(String)

Returns the largest integer divides the numbers without any reminders.

Declaration

public string ComputeGcd(string range)

Parameters

Type	Name	Description
System.String	range	number1,number2,...

Returns

Type	Description
System.String	GCD value of given numbers.

ComputeGeomean(String)

Returns the geometric mean of all values listed in the argument.

Declaration

public string ComputeGeomean(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The geometric mean of all values listed in the argument.

ComputeGestep(String)

Compares the given two values

Declaration

public string ComputeGestep(string argList)

Parameters

Type	Name	Description
System.String	argList	Two Numbers to be compared.

Returns

Type	Description
System.String	Returns the result of the comparision in the form of 0 or 1

ComputeGrowth(String)

Returns the growth estimate using the exponential curve y = b * m^x that best fits the given points. Only the first two Excel parameters are used.

Declaration

public string ComputeGrowth(string range)

Parameters

Type	Name	Description
System.String	range	Y_range, x_range.

Returns

Type	Description
System.String	returns estimated value.

ComputeHarmean(String)

Returns the harmonic mean of all values listed in the argument.

Declaration

public string ComputeHarmean(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The harmonic mean all values listed in the argument.

ComputeHex2Bin(String)

Computes the Binary value for the given Hexadecimal Data.

Declaration

public string ComputeHex2Bin(string argList)

Parameters

Type	Name	Description
System.String	argList	Data to be converted.

Returns

Type	Description
System.String	Returns the calculated Binary value.

ComputeHex2Dec(String)

Computes the Decimal Equivalent for the given Hexadecimal value

Declaration

public string ComputeHex2Dec(string argList)

Parameters

Type	Name	Description
System.String	argList	Data to be converted.

Returns

Type	Description
System.String	The calculated Decimal value for the given.

ComputeHex2Oct(String)

Computes the Octal Equivalent for the given Hexadecimal value

Declaration

public string ComputeHex2Oct(string argList)

Parameters

Type	Name	Description
System.String	argList	Data to be converted.

Returns

Type	Description
System.String	The calculated Octal value for the given.

ComputeHLookUp(String)

Returns a horizontal table look up value.

Declaration

public string ComputeHLookUp(string range)

Parameters

Type	Name	Description
System.String	range	Contains search value, table, return index and match properties.

Returns

Type	Description
System.String	Matching value found in the table.

Remarks

For example, =HLOOKUP("Axles",A1:C4,2,TRUE) looks for the exact match for Axles in A1:C1 and returns the corresponding value in A2:C2.

ComputeHour(String)

Returns the hour of the given time.

Declaration

public string ComputeHour(string argList)

Parameters

Type	Name	Description
System.String	argList	Given time.

Returns

Type	Description
System.String	returns Hour.

ComputeHyperlink(String)

Used to calculate the value of ComputeHyperlink function

Declaration

public string ComputeHyperlink(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values used in the function

Returns

Type
System.String

ComputeHypgeomdist(String)

Returns the hypergeometric distribution.

Declaration

public string ComputeHypgeomdist(string argList)

Parameters

Type	Name	Description
System.String	argList	Number of sample successes, number of sample, number of population successes, number of population.

Returns

Type	Description
System.String	Returns the gamma distribution.

ComputeHypgeomOdist(String)

Returns the hypergeometric distribution.

Declaration

public string ComputeHypgeomOdist(string argList)

Parameters

Type	Name	Description
System.String	argList	Number of sample successes, number of sample, number of population successes, number of population.

Returns

Type	Description
System.String	Returns the gamma distribution.

ComputeIEEERemainder(String)

Used to calculate the value of ComputeIEEERemainder function

Declaration

public string ComputeIEEERemainder(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values used in the function

Returns

Type
System.String

ComputeIf(String)

Conditionally computes one of two alternatives depending upon a logical expression.

Declaration

public string ComputeIf(string args)

Parameters

Type	Name	Description
System.String	args	A string holding a list of three arguments.

Returns

Type	Description
System.String	Returns a string holding the second argument if the first argument is True (non-zero). Otherwise, it returns a string holding the third argument.

Remarks

The first argument is treated as a logical expression with a non-zero value considered True and a zero value considered False. The value of only one of the alternatives is computed depending upon the logical expression.

ComputeIfError(String)

Returns a value you specify if a formula evaluates to an error otherwise, returns the result of the formula.

Declaration

public string ComputeIfError(string args)

Parameters

Type	Name	Description
System.String	args	String to be tested.

Returns

Type
System.String

ComputeIfNA(String)

Returns a value you specify if a formula evaluates to #N/A otherwise, returns the result of the formula.

Declaration

public string ComputeIfNA(string range)

Parameters

Type	Name	Description
System.String	range	String to be tested.

Returns

Type	Description
System.String	Returns the computed value.

ComputeIHDIST(String)

The Irwin-Hall distribution results from the sum on n independent standard uniform variables

Declaration

public string ComputeIHDIST(string range)

Parameters

Type	Name	Description
System.String	range	The value at which to evaluate the distribution.

Returns

Type
System.String

ComputeImABS(String)

Returns the absolute value (modulus) of a complex number in x + yi or x + yj text format.

Declaration

public string ComputeImABS(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The absolute value (modulus) of given complex number

ComputeImaginary(String)

Gets the Imaginary part of the given Complex number.

Declaration

public string ComputeImaginary(string argList)

Parameters

Type	Name	Description
System.String	argList	Given complex number.

Returns

Type	Description
System.String	Imaginary part of the given complex Number.

ComputeImArgument(String)

Returns the argument (theta), an angle expressed in radians

Declaration

public string ComputeImArgument(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The argument (theta), an angle expressed in radians

ComputeImConjugate(String)

Returns the complex conjugate of a complex number in x + yi or x + yj text format.

Declaration

public string ComputeImConjugate(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The complex conjugate of a complex number in x + yi or x + yj text format.

ComputeIMCos(String)

Returns the IMCos of the given Complex Number.

Declaration

public string ComputeIMCos(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The IMCos of the given Complex Number.

ComputeImCosH(String)

Returns the Hyperbolic Cos value of the given Complex Number.

Declaration

public string ComputeImCosH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The Hyperbolic Cos Value of the given Complex Number.

ComputeImCot(String)

Returns the IMCot of the given Complex Number.

Declaration

public string ComputeImCot(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The IMCot of the given Complex Number.

ComputeIMCotH(String)

Returns the IMCotH of the given Complex Number.

Declaration

public string ComputeIMCotH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The IMCotH of the given Complex Number.

ComputeIMCSC(String)

Returns the IMCSC of the given Complex Number.

Declaration

public string ComputeIMCSC(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The IMCSC of the given Complex Number.

ComputeIMCSCH(String)

Returns the IMCSCH of the given Complex Number.

Declaration

public string ComputeIMCSCH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The IMCSCH of the given Complex Number.

ComputeImDiv(String)

Computes the Division of the given Complex Numbers

Declaration

public string ComputeImDiv(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Numbers

Returns

Type	Description
System.String	The Divided result of the two complex numbers.

ComputeImEXP(String)

Returns the Exponent of the given Complex Number.

Declaration

public string ComputeImEXP(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The Exponent of the given Complex Number.

ComputeIMLN(String)

Returns the LOG value of the given Complex Number.

Declaration

public string ComputeIMLN(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The Log of the given Complex Number.

ComputeIMLOG10(String)

Returns the LOG10 value of the given Complex Number.

Declaration

public string ComputeIMLOG10(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The Log10 of the given Complex Number.

ComputeIMLOG2(String)

Returns the Log2 of the given Complex Number.

Declaration

public string ComputeIMLOG2(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The Log2 of the given Complex Number.

ComputeImPower(String)

Returns the power of the given Complex Number.

Declaration

public string ComputeImPower(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The power of the given Complex Number.

ComputeImProduct(String)

Computes the Product of the given Complex Numbers

Declaration

public string ComputeImProduct(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Numbers

Returns

Type	Description
System.String	The multiplied result of the two complex numbers.

ComputeIMSEC(String)

Returns the IMSEC of the given Complex Number.

Declaration

public string ComputeIMSEC(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The IMSEC of the given Complex Number.

ComputeIMSecH(String)

Returns the IMSecH of the given Complex Number.

Declaration

public string ComputeIMSecH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The IMSecH of the given Complex Number.

ComputeIMSin(String)

Returns the IMSin of the given Complex Number.

Declaration

public string ComputeIMSin(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The IMSin of the given Complex Number.

ComputeImSinH(String)

Returns the Hyperbolic Sine value of the given Complex Number.

Declaration

public string ComputeImSinH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The Hyperbolic Sine Value of the given Complex Number.

ComputeImSqrt(String)

Returns the Square Root of the given Complex Number.

Declaration

public string ComputeImSqrt(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The Square Root of the given Complex Number.

ComputeImSub(String)

Computes the Difference of two complex number.

Declaration

public string ComputeImSub(string argList)

Parameters

Type	Name	Description
System.String	argList	Parameter that is used for performing Subtraction

Returns

Type	Description
System.String	The calculated difference of the numbers

ComputeImSum(String)

Computes the sum of two complex number.

Declaration

public string ComputeImSum(string argList)

Parameters

Type	Name	Description
System.String	argList	Parameter that is used for performing sum

Returns

Type	Description
System.String	The calculated sum of the numbers

ComputeIMTan(String)

Returns the IMTan of the given Complex Number.

Declaration

public string ComputeIMTan(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The IMTan of the given Complex Number.

ComputeIMTanH(String)

Returns the IMTanH of the given Complex Number.

Declaration

public string ComputeIMTanH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

Type	Description
System.String	The IMTanH of the given Complex Number.

ComputeIndex(String)

Returns the value at a specified row and column from within a given range.

Declaration

public string ComputeIndex(string arg)

Parameters

Type	Name	Description
System.String	arg	look_range, row, col

Returns

Type	Description
System.String	The value.

Remarks

Both array and reference form of this function are supported.

ComputeIndirect(String)

Returns the reference specified by a text string. References are immediately evaluated to display their contents.

Syntax: INDIRECT(CellRefString, [IsA1Style])

Declaration

public string ComputeIndirect(string args)

Parameters

Type	Name	Description
System.String	args	Cell reference string.

Returns

Type	Description
System.String	Reference specified the argument.

ComputeInfo(String)

Returns the current operation environment information

Declaration

public string ComputeInfo(string argList)

Parameters

Type	Name	Description
System.String	argList	Type

Returns

Type	Description
System.String	environment information

ComputeInt(String)

Returns the integer value.

Declaration

public string ComputeInt(string range)

Parameters

Type	Name	Description
System.String	range	Number to be truncated.

Returns

Type	Description
System.String	An integer.

ComputeIntercept(String)

Returns the y-intercept of the least square fit line through the given points.

Declaration

public string ComputeIntercept(string range)

Parameters

Type	Name	Description
System.String	range	y_range, x_range.

Returns

Type	Description
System.String	returns y-intercept.

ComputeIntrat(String)

Used to calculate the value of ComputeIntrat function

Declaration

public string ComputeIntrat(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents string values used in the function

Returns

Type
System.String

ComputeINTRATE(String)

Returns the interest rate for a fully invested security.

Declaration

public string ComputeINTRATE(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Rate of interest

ComputeIpmt(String)

Computes the interest payment for a period.

Declaration

public string ComputeIpmt(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the rate as percentage per period, the period, number of periods, present value, future value, and payment type (0 = end of period, 1 = start of period).

Returns

Type	Description
System.String	Interest payment.

ComputeIrr(String)

Computes the internal rate of return of a series of cash flows.

Declaration

public string ComputeIrr(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing a range of cells and an initial guess.

Returns

Type	Description
System.String	Internal rate of return.

Remarks

This IRR calculation uses Newton's method to approximate a root of f(r) = Sum( values[i]/(1+r)^i) = 0 where the Sum index is i = 1 to the number of values. The algorithm returns a value if the relative difference between root approximations is less than 1e-5. It fails if this accuracy is not attained in 20 iterations.

ComputeIsBlank(String)

Determines whether the value is empty string.

Declaration

public string ComputeIsBlank(string args)

Parameters

Type	Name	Description
System.String	args	Value to be tested.

Returns

Type	Description
System.String	True if the value is empty, False otherwise.

ComputeIsErr(String)

Returns True is the string denotes an error except #N/A.

Declaration

public string ComputeIsErr(string range)

Parameters

Type	Name	Description
System.String	range	Value to be tested.

Returns

Type	Description
System.String	True if the value is an error except #N/A, false otherwise.

ComputeIsError(String)

Returns True is the string denotes an error.

Declaration

public string ComputeIsError(string range)

Parameters

Type	Name	Description
System.String	range	String to be tested.

Returns

Type	Description
System.String	True if the value is an error.

ComputeIsEven(String)

Determines whether the value is even or not.

Declaration

public string ComputeIsEven(string args)

Parameters

Type	Name	Description
System.String	args	Value to be tested.

Returns

Type	Description
System.String	True, if the value is even, false otherwise.

ComputeIsFormula(String)

Used to calculate the value of ComputeIsFormula function

Declaration

public string ComputeIsFormula(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values used in the function

Returns

Type
System.String

ComputeIsLogical(String)

Determines whether the value is a logical value.

Declaration

public string ComputeIsLogical(string args)

Parameters

Type	Name	Description
System.String	args	Value to be tested.

Returns

Type	Description
System.String	True if the value is a logical value, False otherwise.

ComputeIsNA(String)

Determines whether the value is the #NA error value.

Declaration

public string ComputeIsNA(string args)

Parameters

Type	Name	Description
System.String	args	Value to be tested.

Returns

Type	Description
System.String	True if the value is the #NA error value, False otherwise.

ComputeIsNonText(String)

Determines whether the value is not a string.

Declaration

public string ComputeIsNonText(string args)

Parameters

Type	Name	Description
System.String	args	Value to be tested.

Returns

Type	Description
System.String	True if the value is not a string, false otherwise.

ComputeIsNumber(String)

Determines whether the string contains a number or not.

Declaration

public string ComputeIsNumber(string range)

Parameters

Type	Name	Description
System.String	range	String to be tested.

Returns

Type	Description
System.String	True if the string is a number.

ComputeIsOdd(String)

Determines whether the value is odd or not.

Declaration

public string ComputeIsOdd(string args)

Parameters

Type	Name	Description
System.String	args	Value to be tested.

Returns

Type	Description
System.String	True, if the value is odd, false otherwise.

ComputeISOWeeknum(String)

Returns ISO week number of the year for a given date

Declaration

public string ComputeISOWeeknum(string argList)

Parameters

Type	Name	Description
System.String	argList	date

Returns

Type	Description
System.String	returns ISO week number

ComputeIspmt(String)

Computes the simple interest payment.

Declaration

public string ComputeIspmt(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the rate as percentage per period, the period, number of periods, and present value.

Returns

Type	Description
System.String	Simple interest payment.

ComputeIsRef(String)

Checks whether the value is a reference or not.

Declaration

public string ComputeIsRef(string args)

Parameters

Type	Name	Description
System.String	args	value or reference

Returns

Type	Description
System.String	TRUE or FALSE

ComputeIsText(String)

Determines whether the value is string or not.

Declaration

public string ComputeIsText(string args)

Parameters

Type	Name	Description
System.String	args	Value to be tested.

Returns

Type	Description
System.String	True if the value is a string, false otherwise.

ComputeJis(String)

Used to calculate the value of ComputeJis function

Declaration

public string ComputeJis(string arg)

Parameters

Type	Name	Description
System.String	arg	Represents string values used in the function

Returns

Type
System.String

ComputeKurt(String)

Returns the kurtosis of the passed-in values.

Declaration

public string ComputeKurt(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The kurtosis of the data.

ComputeLarge(String)

Returns the kth largest value in the range.

Declaration

public string ComputeLarge(string range)

Parameters

Type	Name	Description
System.String	range	The Range, k.

Returns

Type	Description
System.String	Kth largest value.

ComputeLcm(String)

Returns the smallest positive integer that is a multiple of all given values.

Declaration

public string ComputeLcm(string range)

Parameters

Type	Name	Description
System.String	range	Number1,Number2,...

Returns

Type	Description
System.String	LCM value of given numbers

ComputeLeft(String)

Returns the left so many characters in the given string.

Declaration

public string ComputeLeft(string range)

Parameters

Type	Name	Description
System.String	range	Contains the string and the number of characters.

Returns

Type	Description
System.String	returns a string.

ComputeLeftB(String)

Returns the left so many characters in the given string.

Declaration

public string ComputeLeftB(string range)

Parameters

Type	Name	Description
System.String	range	Contains the string and the number of characters.

Returns

Type	Description
System.String	A left sub string..

ComputeLen(String)

Returns the length of the given string.

Declaration

public string ComputeLen(string range)

Parameters

Type	Name	Description
System.String	range	Contains the string.

Returns

Type	Description
System.String	An integer length.

ComputeLenB(String)

Returns the length of the given string.

Declaration

public string ComputeLenB(string range)

Parameters

Type	Name	Description
System.String	range	Contains the string.

Returns

Type	Description
System.String	An integer length.

ComputeLn(String)

Computes the natural logarithm of the value in the argument.

Declaration

public string ComputeLn(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding natural logarithm of the value in the argument.

ComputeLog(String)

Computes the logarithm of the first value using the second value as the base.

Declaration

public string ComputeLog(string argList)

Parameters

Type	Name	Description
System.String	argList	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding logarithm of the value in the argument using the second argument as the base.

ComputeLog10(String)

Computes the base 10 logarithm of the value in the argument.

Declaration

public string ComputeLog10(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding base 10 logarithm of the value in the argument.

ComputeLogest(String)

Returns the m parameter of the exponential curve y = b * m^x that best fits the given points. Only the first two Excel parameters are used.

Declaration

public string ComputeLogest(string range)

Parameters

Type	Name	Description
System.String	range	Y_range, x_range.

Returns

Type	Description
System.String	returns m parameter.

ComputeLogestb(String)

Returns the b parameter of the exponential curve y = b * m^x that best fits the given points.

Declaration

public string ComputeLogestb(string range)

Parameters

Type	Name	Description
System.String	range	Y_range, x_range.

Returns

Type	Description
System.String	returns b parameter.

ComputeLoginv(String)

Returns the inverse of the lognormal distribution.

Declaration

public string ComputeLoginv(string argList)

Parameters

Type	Name	Description
System.String	argList	P, mean, standarddev.

Returns

Type	Description
System.String	Returns the value x where the lognormal distribution of x is p.

ComputeLognormdist(String)

Returns the lognormal distribution.

Declaration

public string ComputeLognormdist(string argList)

Parameters

Type	Name	Description
System.String	argList	X, mean, standarddev.

Returns

Type	Description
System.String	Returns lognormal distribution.

ComputeLognormOdist(String)

Returns the lognormal distribution.

Declaration

public string ComputeLognormOdist(string argList)

Parameters

Type	Name	Description
System.String	argList	x, mean, standarddev.

Returns

Type	Description
System.String	The lognormal distribution.

ComputeLognormOinv(String)

Returns the inverse of the lognormal distribution.

Declaration

public string ComputeLognormOinv(string argList)

Parameters

Type	Name	Description
System.String	argList	p, mean, standarddev.

Returns

Type	Description
System.String	Returns the value x where the lognormal distribution of x is p.

ComputeLookUp(String)

Returns a value from result table either from a one-row or one-column range or from an array

Declaration

public string ComputeLookUp(string range)

Parameters

Type	Name	Description
System.String	range	Lookup Value, lookup range, result range

Returns

Type	Description
System.String	Matching value found in the table

ComputeLower(String)

Converts text to lowercase.

Declaration

public string ComputeLower(string args)

Parameters

Type	Name	Description
System.String	args	Value to convert.

Returns

Type	Description
System.String	Converted string.

ComputeMax(String)

Returns the maximum value of all values listed in the argument.

Declaration

public string ComputeMax(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the maximum value of all values listed in the argument.

ComputeMaxa(String)

Returns the maximum value of all values listed in the argument including logical values.

Declaration

public string ComputeMaxa(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the maximum value of all values listed in the argument.

Remarks

True is treated as 1 and False is treated as 0.

ComputeMdeterm(String)

Returns the number of columns of the passed in cell reference.

Declaration

public string ComputeMdeterm(string arg)

Parameters

Type	Name	Description
System.String	arg	Contains one argument - reference

Returns

Type	Description
System.String	number of columns.

ComputeMedian(String)

Returns the median value in the range.

Declaration

public string ComputeMedian(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	Median value.

ComputeMid(String)

Returns a substring of the given string.

Declaration

public string ComputeMid(string range)

Parameters

Type	Name	Description
System.String	range	Contains the original string, start position of the substring, and the number of characters in the substring.

Returns

Type	Description
System.String	returns a string.

ComputeMidB(String)

Returns a substring of the given string.

Declaration

public string ComputeMidB(string range)

Parameters

Type	Name	Description
System.String	range	Contains the original string, start position of the substring, and the number of characters in the substring.

Returns

Type	Description
System.String	A substring.

ComputeMin(String)

Returns the minimum value of all values listed in the argument.

Declaration

public string ComputeMin(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the minimum value of all values listed in the argument.

ComputeMina(String)

Returns the minimum value of all values listed in the argument including logical values.

Declaration

public string ComputeMina(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the minimum value of all values listed in the argument.

Remarks

True is treated as 1 and False is treated as 0.

ComputeMinute(String)

Returns the Minute of the given time.

Declaration

public string ComputeMinute(string argList)

Parameters

Type	Name	Description
System.String	argList	Given time.

Returns

Type	Description
System.String	returns Minute.

ComputeMInverse(String)

Returns the number of columns of the passed in cell reference.

Declaration

public string ComputeMInverse(string arg)

Parameters

Type	Name	Description
System.String	arg	Contains one argument - reference

Returns

Type	Description
System.String	number of columns.

ComputeMirr(String)

Computes the modified internal rate of return of a series of cash flows.

Declaration

public string ComputeMirr(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing a range of cells, finance interest rate, and a reinvest interest rate.

Returns

Type	Description
System.String	Modified internal rate of return.

ComputeMmult(String)

Returns the number of columns of the passed in cell reference.

Declaration

public string ComputeMmult(string arg)

Parameters

Type	Name	Description
System.String	arg	Contains one argument - reference

Returns

Type	Description
System.String	number of columns.

ComputeMod(String)

Returns the remainder after dividing one number by another.

Declaration

public string ComputeMod(string range)

Parameters

Type	Name	Description
System.String	range	Two numbers in a list.

Returns

Type	Description
System.String	The remainder.

ComputeMode(String)

Returns the most frequent value in the range.

Declaration

public string ComputeMode(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The most frequent value.

ComputeModeOMult(String)

Returns a vertical array of the most frequently occurring, or repetitive values in an array or range of data.

Declaration

public string ComputeModeOMult(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of cell references, formulas, or numbers.

Returns

Type	Description
System.String	The most frequent value.

ComputeModeOsngl(String)

Returns the most frequent value in the range.

Declaration

public string ComputeModeOsngl(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of cell references, formulas, or numbers.

Returns

Type	Description
System.String	The most frequent value.

ComputeMonth(String)

Returns the month of the given date.

Declaration

public string ComputeMonth(string argList)

Parameters

Type	Name	Description
System.String	argList	Given time.

Returns

Type	Description
System.String	returns Month.

ComputeMround(String)

Rounds the given number to a specified multiple number

Declaration

public string ComputeMround(string argList)

Parameters

Type	Name	Description
System.String	argList	Given number, multiple value

Returns

Type	Description
System.String	Mround value of given number

ComputeMultinomial(String)

Returns the Multinominal value of given range of numbers.

Declaration

public string ComputeMultinomial(string range)

Parameters

Type	Name	Description
System.String	range	Given numbers

Returns

Type	Description
System.String	Multinominal value of given range of numbers

ComputeMUnit(String)

Returns the number of columns of the passed in cell reference.

Declaration

public string ComputeMUnit(string arg)

Parameters

Type	Name	Description
System.String	arg	Contains one argument - reference

Returns

Type	Description
System.String	number of columns.

ComputeN(String)

Returns a number converted from the provided value.

Declaration

public string ComputeN(string args)

Parameters

Type	Name	Description
System.String	args	Value to be converted.

Returns

Type	Description
System.String	A number in string format or an error string.

ComputeNA()

Returns the error value (#N/A - value not available).

Declaration

public string ComputeNA()

Returns

Type	Description
System.String	error value.

ComputeNegbinomdist(String)

Returns the negative binomial distribution.

Declaration

public string ComputeNegbinomdist(string argList)

Parameters

Type	Name	Description
System.String	argList	Number of failures, success threshold, probability, cumulative.

Returns

Type	Description
System.String	Returns negative binomial distribution.

ComputeNegbinomODist(String)

Returns the negative binomial distribution.

Declaration

public string ComputeNegbinomODist(string argList)

Parameters

Type	Name	Description
System.String	argList	Number of failures, success threshold, probability, cumulative.

Returns

Type	Description
System.String	The negative binomial distribution.

ComputeNetworkDays(String)

Returns the total number of working days between the two dates.

Declaration

public string ComputeNetworkDays(string argList)

Parameters

Type	Name	Description
System.String	argList	start date, end date, number of holidays.

Returns

Type	Description
System.String	number of working days.

ComputeNetworkDaysintl(String)

Returns the number of whole workdays between two dates, week end and holidays are not consider as working days

Declaration

public string ComputeNetworkDaysintl(string argList)

Parameters

Type	Name	Description
System.String	argList	start_date, end_date,weekend (optional), holidays (optional)

Returns

Type	Description
System.String	return the work days

ComputeNormdist(String)

Returns the normal distribution.

Declaration

public string ComputeNormdist(string argList)

Parameters

Type	Name	Description
System.String	argList	X, mean, standarddev, cumulative.

Returns

Type	Description
System.String	Returns normal distribution.

Remarks

Cumulative should be either True if you want to return the value of the distribution function or False if you want to return the value of the density function. The distribution value is computed interactively using Trapezoidal Rule to six to seven significant digits or 20 iteration maximum.

ComputeNorminv(String)

Returns the inverse of normal distribution.

Declaration

public string ComputeNorminv(string argList)

Parameters

Type	Name	Description
System.String	argList	P, mean, standard deviation.

Returns

Type	Description
System.String	Returns x such that normal distribution at x is p.

Remarks

P should be between 0 and 1.

ComputeNormOdist(String)

Returns the normal distribution for the specified mean and standard deviation.

Declaration

public string ComputeNormOdist(string argList)

Parameters

Type	Name	Description
System.String	argList	x, mean, standarddev, cumulative.

Returns

Type	Description
System.String	The normal distribution.

Remarks

Cumulative should be either True if you want to return the value of the distribution function or False if you want to return the value of the density function.

ComputeNormOinv(String)

Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation.

Declaration

public string ComputeNormOinv(string argList)

Parameters

Type	Name	Description
System.String	argList	P, mean, standard deviation.

Returns

Type	Description
System.String	Returns x such that normal distribution at x is p.

Remarks

P should be between 0 and 1.

ComputeNormOsODist(String)

Returns the standard normal cumulative distribution function. The distribution has a mean of 0 (zero) and a standard deviation of one.

Syntax: NORMSDIST(z)

Declaration

public string ComputeNormOsODist(string argList)

Parameters

Type	Name	Description
System.String	argList	Z is the value for which you want the distribution.

Returns

Type	Description
System.String	Standard normal cumulative distribution.

ComputeNormOsOInv(String)

Returns the inverse of the standard normal cumulative distribution. The distribution has a mean of zero and a standard deviation of one.

Syntax: NORMSINV(p)

Declaration

public string ComputeNormOsOInv(string argList)

Parameters

Type	Name	Description
System.String	argList	p is a probability corresponding to the normal distribution.

Returns

Type	Description
System.String	Inverse of standard normal cumulative distribution.

Remarks

p should be between 0 and 1.

ComputeNormsDist(String)

Returns the standard normal cumulative distribution function. The distribution has a mean of 0 (zero) and a standard deviation of one.

Syntax: NORMSDIST(z)

Declaration

public string ComputeNormsDist(string argList)

Parameters

Type	Name	Description
System.String	argList	Z is the value for which you want the distribution.

Returns

Type	Description
System.String	Returns string standard normal cumulative distribution function

ComputeNormsInv(String)

Returns the inverse of the standard normal cumulative distribution. The distribution has a mean of zero and a standard deviation of one.

Syntax: NORMSINV(p)

Declaration

public string ComputeNormsInv(string argList)

Parameters

Type	Name	Description
System.String	argList	p is a probability corresponding to the normal distribution.

Returns

Type	Description
System.String	Returns string for inverse of the standard normal cumulative distribution

Remarks

p should be between 0 and 1.

ComputeNot(String)

Flips the logical value represented by the argument.

Declaration

public string ComputeNot(string args)

Parameters

Type	Name	Description
System.String	args	A string holding either a single argument consisting of a cell reference, a formula, or a number.

Returns

Type	Description
System.String	Returns 0 if the argument evaluates to a non-zero value. Otherwise, it returns 1.

Remarks

The argument is treated as a logical expression with a non-zero value considered True and a zero value considered False.

ComputeNow(String)

Returns the current date and time as a date serial number.

Declaration

public string ComputeNow(string argList)

Parameters

Type	Name	Description
System.String	argList	value ignored.

Returns

Type	Description
System.String	rCurrent date and time as serial number.

ComputeNper(String)

Computes the number of periods in an investment.

Declaration

public string ComputeNper(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the rate as percentage per period, payment per period, present value, future value, and payment type (0 = end of period, 1 = start of period).

Returns

Type	Description
System.String	Number of periods.

ComputeNpv(String)

Computes the net present value of an investment.

Declaration

public string ComputeNpv(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the rate as percentage per period and a list of invested values.

Returns

Type	Description
System.String	Net present value.

ComputeNumberValue(String)

Convert the text to number

Declaration

public string ComputeNumberValue(string argList)

Parameters

Type	Name	Description
System.String	argList	text,

Returns

Type	Description
System.String	decimal separator,group separator

ComputeOct2Bin(String)

Computes the Binary value for the given Octal Number.

Declaration

public string ComputeOct2Bin(string argList)

Parameters

Type	Name	Description
System.String	argList	Data to be converted.

Returns

Type	Description
System.String	Returns the calculated Binary value.

ComputeOct2Dec(String)

Computes the Decimal Equivalent for the given Octal value

Declaration

public string ComputeOct2Dec(string argList)

Parameters

Type	Name	Description
System.String	argList	The Value to be converted to Decimal

Returns

Type	Description
System.String	The calculated value for the given

ComputeOct2Hex(String)

Calculates the Hexadecimal equivalent value for the given Octal value

Declaration

public string ComputeOct2Hex(string argList)

Parameters

Type	Name	Description
System.String	argList	Data to be converted.

Returns

Type	Description
System.String	The Converted Hexadecimal value.

ComputeOdd(String)

Rounds up to larger in magnitude odd number.

Declaration

public string ComputeOdd(string args)

Parameters

Type	Name	Description
System.String	args	Number to be rounded.

Returns

Type	Description
System.String	Rounded odd value.

ComputeOr(String)

Returns the inclusive OR of all values treated as logical values listed in the argument.

Declaration

public string ComputeOr(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers. Each item in the list is considered True if it is nonzero, and False if it is zero.

Returns

Type	Description
System.String	A string holding the OR of all values listed in the argument.

ComputePearson(String)

Returns the Pearson product moment correlation coefficient.

Declaration

public string ComputePearson(string range)

Parameters

Type	Name	Description
System.String	range	range1, range2

Returns

Type	Description
System.String	Pearson product

ComputePercentile(String)

Returns the percentile position in the range.

Declaration

public string ComputePercentile(string range)

Parameters

Type	Name	Description
System.String	range	The Range, k.

Returns

Type	Description
System.String	Percentile position.

Remarks

K is a value between 0 and 1.

ComputePercentileExc(String)

Returns the percentile position in the range.

Declaration

public string ComputePercentileExc(string range)

Parameters

Type	Name	Description
System.String	range	Range, k.

Returns

Type	Description
System.String	Percentile position.

Remarks

K is a value between 0 and 1.

ComputePercentileInc(String)

Returns the percentile position in the range.

Declaration

public string ComputePercentileInc(string range)

Parameters

Type	Name	Description
System.String	range	Range, k.

Returns

Type	Description
System.String	Percentile position.

Remarks

K is a value between 0 and 1.

ComputePercentrank(String)

Returns the percentage rank in the range.

Declaration

public string ComputePercentrank(string range)

Parameters

Type	Name	Description
System.String	range	Range, x, significant digits.

Returns

Type	Description
System.String	Percentile position.

Remarks

Significant digits are optional, defaulting to 3.

ComputePercentrankExc(String)

Returns the percentage rank Exc in the range.

Declaration

public string ComputePercentrankExc(string range)

Parameters

Type	Name	Description
System.String	range	Range, x, significant digits.

Returns

Type	Description
System.String	Percentile position.

Remarks

Significant digits are optional, defaulting to 3.

ComputePercentrankInc(String)

Returns the percentage rank Inc in the range.

Declaration

public string ComputePercentrankInc(string range)

Parameters

Type	Name	Description
System.String	range	Range, x, significant digits.

Returns

Type	Description
System.String	Percentile position.

Remarks

Significant digits are optional, defaulting to 3.

ComputePermut(String)

The number of permutations of n items taken k at the time.

Declaration

public string ComputePermut(string argList)

Parameters

Type	Name	Description
System.String	argList	The arglist, N, k

Returns

Type	Description
System.String	The number of combinations.

ComputePermutationA(String)

Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects.

Declaration

public string ComputePermutationA(string argList)

Parameters

Type	Name	Description
System.String	argList	n, k

Returns

Type	Description
System.String	The number of combinations.

ComputePI(String)

Returns the number pi.

Declaration

public string ComputePI(string args)

Parameters

Type	Name	Description
System.String	args	Ignored. Can be empty.

Returns

Type	Description
System.String	A string holding the number pi.

ComputePmt(String)

Computes the payment for a loan.

Declaration

public string ComputePmt(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the rate as percentage per period, number of periods, present value, future value, and payment type (0 = end of period, 1 = start of period).

Returns

Type	Description
System.String	Payment amount.

ComputePoisson(String)

Returns the Poisson distribution.

Declaration

public string ComputePoisson(string argList)

Parameters

Type	Name	Description
System.String	argList	X, mean, cumulative.

Returns

Type	Description
System.String	Returns the exponential distribution.

Remarks

Cumulative should be either True if you want to return the value of the distribution function or False if you want to return the value of the density function.

ComputePoissonODist(String)

Returns the Poisson distribution.

Declaration

public string ComputePoissonODist(string argList)

Parameters

Type	Name	Description
System.String	argList	x, mean, cumulative

Returns

Type	Description
System.String	Returns the exponential distribution.

Remarks

Cumulative should be either True if you want to return the value of the distribution function or False if you want to return the value of the density function.

ComputePow(String)

Returns a specified number raised to the specified power.

Declaration

public string ComputePow(string args)

Parameters

Type	Name	Description
System.String	args	String containing two parameters separated by commas: the first being base number, the second being the exponent.

Returns

Type	Description
System.String	A string holding the value of the base number raised to the exponent.

ComputePpmt(String)

Computes the principal payment for a period.

Declaration

public string ComputePpmt(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the rate as percentage per period, the period, number of periods, present value, future value, and payment type (0 = end of period, 1 = start of period).

Returns

Type	Description
System.String	Principal payment.

ComputeProb(String)

Returns the probability that a value in the given range occurs.

Declaration

public string ComputeProb(string range)

Parameters

Type	Name	Description
System.String	range	Xrange1, prange2, lowerbound, upperbound.

Returns

Type	Description
System.String	The probability.

ComputeProduct(String)

Returns the product of the arguments in the list.

Declaration

public string ComputeProduct(string range)

Parameters

Type	Name	Description
System.String	range	List of arguments.

Returns

Type	Description
System.String	Product of the arguments.

ComputeProper(String)

Returns the text like first letter with upper letter in each word

Declaration

public string ComputeProper(string argList)

Parameters

Type	Name	Description
System.String	argList	Text

Returns

Type	Description
System.String	proper text

ComputePv(String)

Computes the present value of an investment.

Declaration

public string ComputePv(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the rate as percentage per period, number of periods, payment per period, future value, and payment type (0 = end of period, 1 = start of period).

Returns

Type	Description
System.String	Present value.

ComputeQuartile(String)

Returns the quartile position in the range.

Declaration

public string ComputeQuartile(string range)

Parameters

Type	Name	Description
System.String	range	The Range, q.

Returns

Type	Description
System.String	Percentile position.

Remarks

Q is 0, 1, 2, 3, 4.

ComputeQuartileOExc(String)

Returns the quartile position in the range.

Declaration

public string ComputeQuartileOExc(string range)

Parameters

Type	Name	Description
System.String	range	Range, q.

Returns

Type	Description
System.String	Percentile position.

Remarks

Q is 0, 1, 2, 3, 4.

ComputeQuartileOInc(String)

Returns the quartile position in the range.

Declaration

public string ComputeQuartileOInc(string range)

Parameters

Type	Name	Description
System.String	range	Range, q.

Returns

Type	Description
System.String	Percentile position.

Remarks

Q is 0, 1, 2, 3, 4.

ComputeQuotient(String)

Returns the integer portion of division function.

Declaration

public string ComputeQuotient(string range)

Parameters

Type	Name	Description
System.String	range	Numerator, Denominator to find the quotient

Returns

Type	Description
System.String	Returns integer value.

ComputeRadians(String)

Converts degrees into radians.

Declaration

public string ComputeRadians(string args)

Parameters

Type	Name	Description
System.String	args	Value in degrees.

Returns

Type	Description
System.String	returns Radians.

ComputeRand(String)

Returns an evenly distributed random number greater than or equal zero and less than one.

Declaration

public string ComputeRand(string args)

Parameters

Type	Name	Description
System.String	args	Ignored. Can be empty.

Returns

Type	Description
System.String	A string holding the random number.

ComputeRandbetween(String)

Returns the random integer number between the given two numbers.

Declaration

public string ComputeRandbetween(string argList)

Parameters

Type	Name	Description
System.String	argList	StartNumber, EndNumber

Returns

Type	Description
System.String	Random number between two values

ComputeRank(String)

Returns the rank of x in the range.

Declaration

public string ComputeRank(string range)

Parameters

Type	Name	Description
System.String	range	X, range, order.

Returns

Type	Description
System.String	returns Rank.

ComputeRankOAvg(String)

Returns the rank of x in the range.

Declaration

public string ComputeRankOAvg(string range)

Parameters

Type	Name	Description
System.String	range	X, range, order.

Returns

Type	Description
System.String	Rank of x.

ComputeRankOEq(String)

Returns the rank of x in the range.

Declaration

public string ComputeRankOEq(string range)

Parameters

Type	Name	Description
System.String	range	X, range, order.

Returns

Type	Description
System.String	Rank of x.

ComputeRate(String)

Computes the internal rate of return of a series of cash flows.

Declaration

public string ComputeRate(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing a range of cells and an initial guess.

Returns

Type	Description
System.String	Internal rate of return.

Remarks

This IRR calculation uses Newton's method to approximate a root of f(r) = Sum( values[i]/(1+r)^i) = 0 where the Sum index is i = 1 to the number of values. The algorithm returns a value if the relative difference between root approximations is less than 1e-7. It fails if this accuracy is not attained in 20 iterations.

ComputeReal(String)

Gets the Real part of the given Complex number.

Declaration

public string ComputeReal(string argList)

Parameters

Type	Name	Description
System.String	argList	Given complex number.

Returns

Type	Description
System.String	Real part of the given complex Number.

ComputeReceived(String)

Returns the amount received at maturity for a fully invested security.

Declaration

public string ComputeReceived(string args)

Parameters

Type	Name	Description
System.String	args	Number and the number of digits

Returns

Type	Description
System.String	Received amount

ComputeReplace(String)

Replace the part of the text with a new text from orginal text

Declaration

public string ComputeReplace(string argList)

Parameters

Type	Name	Description
System.String	argList	Text,Start index, Number of char to replace, new text

Returns

Type	Description
System.String	replaced string

ComputeReplaceB(String)

replaces part of a text string, based on the number of characters, with a different text string

Declaration

public string ComputeReplaceB(string argList)

Parameters

Type	Name	Description
System.String	argList	Text in which is want to replace, The position of the character in old_text., The number of characters in old_text

Returns

Type	Description
System.String	returns replaced text

ComputeRept(String)

Returns the number of repeated text

Declaration

public string ComputeRept(string argList)

Parameters

Type	Name	Description
System.String	argList	text, repeated count

Returns

Type	Description
System.String	text

ComputeRight(String)

Returns the right so many characters in the given string.

Declaration

public string ComputeRight(string range)

Parameters

Type	Name	Description
System.String	range	Contains the string and the number of characters.

Returns

Type	Description
System.String	returns a string.

ComputeRightB(String)

Returns the right so many characters in the given string.

Declaration

public string ComputeRightB(string range)

Parameters

Type	Name	Description
System.String	range	Contains the string and the number of characters.

Returns

Type	Description
System.String	A right substring.

ComputeRoman(String)

Returns the arabic numeral to roman in TEXT format

Declaration

public string ComputeRoman(string argList)

Parameters

Type	Name	Description
System.String	argList	Number ,Form for style of roman text 0 or omitted Classic. 1 More concise. 2 More concise. 3 More concise. 4 Simplified. TRUE Classic. FALSE Simplified.

Returns

Type	Description
System.String	Retuns the Roman string of given numaric value based on the style form

ComputeRound(String)

Rounds a number to a specified number of digits.

Declaration

public string ComputeRound(string argList)

Parameters

Type	Name	Description
System.String	argList	Number and number of digits.

Returns

Type	Description
System.String	Rounded number.

ComputeRounddown(String)

Rounds a number to a specified number of digits.

Declaration

public string ComputeRounddown(string argList)

Parameters

Type	Name	Description
System.String	argList	Number and number of digits.

Returns

Type	Description
System.String	Rounded number.

ComputeRoundup(String)

Rounds a number to a specified number of digits.

Declaration

public string ComputeRoundup(string argList)

Parameters

Type	Name	Description
System.String	argList	Number and number of digits.

Returns

Type	Description
System.String	Rounded number.

ComputeRow(String)

Returns the row index of the passed in cell reference.

Declaration

public string ComputeRow(string arg)

Parameters

Type	Name	Description
System.String	arg	Contains zero or one argument. If no argument is passed, returns the row index of the location of this Row function cell, otherwise returns the row index of the passed in cell reference.

Returns

Type	Description
System.String	The row index.

Remarks

This method doesn't return an array of row numbers as the array formula entry is not supported in engine. It is another usecase of this library function.

ComputeRows(String)

Returns the number of rows of the passed in cell reference.

Declaration

public string ComputeRows(string arg)

Parameters

Type	Name	Description
System.String	arg	Contains one argument.

Returns

Type	Description
System.String	number of rows.

ComputeRRI(String)

Calculates the equivalent interest rate for the growth of an investment.

Declaration

public string ComputeRRI(string args)

Parameters

Type	Name	Description
System.String	args	Investment periods, present and future value of the investments.

Returns

Type	Description
System.String	Returns the equivalent interest.

ComputeRsq(String)

Returns the square of the Pearson product moment correlation coefficient.

Declaration

public string ComputeRsq(string range)

Parameters

Type	Name	Description
System.String	range	Range1, range2.

Returns

Type	Description
System.String	Square of the Pearson product.

ComputeSearch(String)

Returns the number of the starting position of the first string from the second string.

Declaration

public string ComputeSearch(string argList)

Parameters

Type	Name	Description
System.String	argList	first strring, second string and starting position

Returns

Type	Description
System.String	index of the string

ComputeSearchB(String)

Returns the number of the starting position of the first string from the second string.

Declaration

public string ComputeSearchB(string argList)

Parameters

Type	Name	Description
System.String	argList	first strring, second string and starting position

Returns

Type	Description
System.String	index of the string

ComputeSecant(String)

Returns the secant of an angle.

Declaration

public string ComputeSecant(string argList)

Parameters

Type	Name	Description
System.String	argList	A cell reference, or number.

Returns

Type	Description
System.String	A string conaining the secant of an angle

ComputeSecanth(String)

Returns the hyperbolic secant of an angle.

Declaration

public string ComputeSecanth(string argList)

Parameters

Type	Name	Description
System.String	argList	A cell reference, or number

Returns

Type	Description
System.String	A string containing the hyperbolic secant of an angle.

ComputeSecond(String)

Returns the second of the given time.

Declaration

public string ComputeSecond(string argList)

Parameters

Type	Name	Description
System.String	argList	Given time.

Returns

Type	Description
System.String	returns Second.

ComputeSeriessum(String)

Used to calculate the value of ComputeSeriessum function

Declaration

public string ComputeSeriessum(string arg)

Parameters

Type	Name	Description
System.String	arg	Represents the string values used in the function

Returns

Type
System.String

ComputeSheet(String)

return the sheet number of the given value

Declaration

public string ComputeSheet(string argList)

Parameters

Type	Name	Description
System.String	argList	SheetName or cell or named range

Returns

Type	Description
System.String	sheet number

ComputeSheets(String)

return the sheet number of the given values

Declaration

public string ComputeSheets(string argList)

Parameters

Type	Name	Description
System.String	argList	SheetName or cell or named range

Returns

Type	Description
System.String	sheet number

ComputeSign(String)

Returns a number indicating the sign of the argument.

Declaration

public string ComputeSign(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding a number representing the sign of the argument.

ComputeSin(String)

Computes the sine of the argument.

Declaration

public string ComputeSin(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the sine of the argument.

ComputeSinh(String)

Computes the hyperbolic sine of the argument.

Declaration

public string ComputeSinh(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the hyperbolic sine of the argument.

ComputeSkew(String)

Returns the skewness of a distribution.

Declaration

public string ComputeSkew(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	Skewness of a distribution.

ComputeSkewP(String)

Returns the skewness of a distribution based on a population a characterization of the degree of asymmetry of a distribution around its mean.

Declaration

public string ComputeSkewP(string range)

Parameters

Type	Name	Description
System.String	range	numbers or names, arrays, or reference that contain numbers

Returns

Type	Description
System.String	Skewness of a distribution.

ComputeSln(String)

Computes the straight-line depreciation of an asset per period.

Declaration

public string ComputeSln(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the cost, salvage value, and life.

Returns

Type	Description
System.String	returns Depreciation.

ComputeSlope(String)

Returns the slope of the least square fit line through the given points.

Declaration

public string ComputeSlope(string range)

Parameters

Type	Name	Description
System.String	range	Y_range, x_range.

Returns

Type	Description
System.String	returns y-intercept.

ComputeSmall(String)

Returns the kth smallest value in the range.

Declaration

public string ComputeSmall(string range)

Parameters

Type	Name	Description
System.String	range	The Range, k.

Returns

Type	Description
System.String	Kth smallest value.

ComputeSqrt(String)

Computes the square root of the argument.

Declaration

public string ComputeSqrt(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the square root of the argument.

ComputeSqrtpi(String)

Return the square root of product of given number with PI.

Declaration

public string ComputeSqrtpi(string args)

Parameters

Type	Name	Description
System.String	args	number to find Sqrtpi.

Returns

Type	Description
System.String	Return Sqrtpi value of giveen number

ComputeStandardize(String)

Returns a normalized value.

Declaration

public string ComputeStandardize(string argList)

Parameters

Type	Name	Description
System.String	argList	X, mean, stddev.

Returns

Type	Description
System.String	Normalized value.

ComputeStdev(String)

Returns the sample standard deviation.

Declaration

public string ComputeStdev(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The sample standard deviation.

ComputeStdeva(String)

Returns the sample standard deviation.

Declaration

public string ComputeStdeva(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The sample standard deviation.

Remarks

Treats True as 1 and False as 0.

ComputeStdevaP(String)

Returns the sample standard deviation.

Declaration

public string ComputeStdevaP(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of cell references, formulas, or numbers.

Returns

Type	Description
System.String	The sample standard deviation.

Remarks

Treats True as 1; False as 0.

ComputeStdevaS(String)

Returns the sample standard deviation.

Declaration

public string ComputeStdevaS(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of cell references, formulas, or numbers.

Returns

Type	Description
System.String	The sample standard deviation.

Remarks

Treats True as 1; False as 0.

ComputeStdevp(String)

Returns the population standard deviation.

Declaration

public string ComputeStdevp(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The population standard deviation.

ComputeStdevpa(String)

Returns the population standard deviation.

Declaration

public string ComputeStdevpa(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The population standard deviation.

Remarks

Treats True as 1 and False as 0.

ComputeSteyx(String)

Returns the standard error of the least square fit line through the given points.

Declaration

public string ComputeSteyx(string range)

Parameters

Type	Name	Description
System.String	range	Y_range, x_range.

Returns

Type	Description
System.String	Standard error.

ComputeSubstitute(String)

In a given string, this method substitutes an occurrence of one string with another string.

Declaration

public string ComputeSubstitute(string range)

Parameters

Type	Name	Description
System.String	range	A list of 3 or 4 arguments: the original string, the search string, the replacement string, and optionally, an integer representing the occurrence to be replaced.

Returns

Type	Description
System.String	The modified string.

ComputeSum(String)

Returns the sum of all values listed in the argument.

Declaration

public string ComputeSum(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the sum of all values listed in the argument.

ComputeSumIf(String)

Computes the sum of range2 if the item in the range1 satisfies the condition.

Declaration

public string ComputeSumIf(string range)

Parameters

Type	Name	Description
System.String	range	Range1, condition, range2.

Returns

Type	Description
System.String	The conditional sum.

ComputeSumIFS(String)

Returns the sum value of all cells that meet multiple criteria.

Declaration

public string ComputeSumIFS(string argList)

Parameters

Type	Name	Description
System.String	argList	range of cells, criteria1, average_range1,...

Returns

Type	Description
System.String	returns the sum value of all cells.

ComputeSumProduct(String)

Returns the sum of the products of corresponding values.

Declaration

public string ComputeSumProduct(string range)

Parameters

Type	Name	Description
System.String	range	Two cell ranges.

Returns

Type	Description
System.String	Sum of the products.

ComputeSumsq(String)

Returns the sum of the square of all values listed in the argument.

Declaration

public string ComputeSumsq(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	A string holding the sum of the squares of all values listed in the argument.

ComputeSumx2my2(String)

Returns the sum of the differences of squares of the two ranges.

Declaration

public string ComputeSumx2my2(string range)

Parameters

Type	Name	Description
System.String	range	x_range and y_range.

Returns

Type	Description
System.String	A string holding sum of the differences of squares.

ComputeSumx2py2(String)

Returns the sum of the sums of squares of the two ranges.

Declaration

public string ComputeSumx2py2(string range)

Parameters

Type	Name	Description
System.String	range	x_range and y_range.

Returns

Type	Description
System.String	A string holding sum of the sums of squares.

ComputeSumxmy2(String)

Returns the sum of the squares of the differences between two ranges.

Declaration

public string ComputeSumxmy2(string range)

Parameters

Type	Name	Description
System.String	range	x_range and y_range.

Returns

Type	Description
System.String	A string holding sum of the squares of the differences.

ComputeSyd(String)

Computes the sum of years digits depreciation of an asset per period.

Declaration

public string ComputeSyd(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the cost, salvage value, life, and period.

Returns

Type	Description
System.String	Depreciation for the requested period.

ComputeT(String)

Returns the string or text referred by the given value.

Declaration

public string ComputeT(string args)

Parameters

Type	Name	Description
System.String	args	value to find the refrred text - Required

Returns

Type	Description
System.String	Referred Text

ComputeTan(String)

Computes the tangent the argument.

Declaration

public string ComputeTan(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the tangent of the argument.

ComputeTanh(String)

Computes the hyperbolic tangent of the argument.

Declaration

public string ComputeTanh(string args)

Parameters

Type	Name	Description
System.String	args	A cell reference, formula, or number.

Returns

Type	Description
System.String	A string holding the hyperbolic tangent of the argument.

ComputeText(String)

Returns a quoted string from a date or number.

Declaration

public string ComputeText(string range)

Parameters

Type	Name	Description
System.String	range	Value to be converted to a string.

Returns

Type	Description
System.String	Quoted string.

ComputeTime(String)

Returns a fraction of a day.

Declaration

public string ComputeTime(string argList)

Parameters

Type	Name	Description
System.String	argList	Hour, minute, and second.

Returns

Type	Description
System.String	Fraction of a day.

ComputeTimevalue(String)

Returns a fraction of a day.

Declaration

public string ComputeTimevalue(string argList)

Parameters

Type	Name	Description
System.String	argList	Time as a text string.

Returns

Type	Description
System.String	Fraction of a day.

ComputeToday(String)

Returns the current date as a date serial number.

Declaration

public string ComputeToday(string argList)

Parameters

Type	Name	Description
System.String	argList	value ignored.

Returns

Type	Description
System.String	Current date as date serial number.

ComputeTOdist(String)

Returns the Student's t-distribution.

Declaration

public string ComputeTOdist(string argList)

Parameters

Type	Name	Description
System.String	argList	x, degreesfreedom1.

Returns

Type	Description
System.String	Returns the Student's t-distribution.

ComputeTOInv(String)

Returns the Student's t-distribution.

Declaration

public string ComputeTOInv(string argList)

Parameters

Type	Name	Description
System.String	argList	x, degreesfreedom1.

Returns

Type	Description
System.String	Returns the Student's t-distribution.

ComputeTranspose(String)

Used to calculate the value of ComputeTranspose function

Declaration

public string ComputeTranspose(string arg)

Parameters

Type	Name	Description
System.String	arg	Represents the string values used in the function

Returns

Type
System.String

ComputeTrim(String)

Removes all leading and trailing white-space characters.

Declaration

public string ComputeTrim(string args)

Parameters

Type	Name	Description
System.String	args	Value to trim.

Returns

Type	Description
System.String	The string that remains after all leading and trailing white-space characters were removed.

ComputeTrimmean(String)

Returns the mean of the range after removing points on either extreme.

Declaration

public string ComputeTrimmean(string range)

Parameters

Type	Name	Description
System.String	range	Range, percent.

Returns

Type	Description
System.String	Kth smallest value.

ComputeTrue(String)

Returns the logical value True.

Declaration

public string ComputeTrue(string empty)

Parameters

Type	Name	Description
System.String	empty

Returns

Type	Description
System.String	Logical True value string.

ComputeTrunc(String)

Truncates a number to an integer.

Declaration

public string ComputeTrunc(string range)

Parameters

Type	Name	Description
System.String	range	Value and number of digits.

Returns

Type	Description
System.String	Truncated value.

ComputeTruncate(String)

Used to calculate the value of ComputeTruncate function

Declaration

public string ComputeTruncate(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values used in the function

Returns

Type
System.String

ComputeType(String)

Returns the interger value for the datatype of given text

Declaration

public string ComputeType(string argList)

Parameters

Type	Name	Description
System.String	argList	text

Returns

Type	Description
System.String	integer value

ComputeUniChar(String)

Returns the Unicode char for the respective numeric value

Declaration

public string ComputeUniChar(string argList)

Parameters

Type	Name	Description
System.String	argList	Number

Returns

Type	Description
System.String	unicode char

ComputeUniCode(String)

Returns the corresponding number code for the first char of string.

Declaration

public string ComputeUniCode(string argList)

Parameters

Type	Name	Description
System.String	argList	text

Returns

Type	Description
System.String	numeric code

ComputeUnidist(String)

Returns the PDF of the uniform distribution.

Declaration

public string ComputeUnidist(string argList)

Parameters

Type	Name	Description
System.String	argList	Number of successes, number of trials, probability, cumulative.

Returns

Type	Description
System.String	The binomial distribution.

ComputeUpper(String)

Converts text to uppercase.

Declaration

public string ComputeUpper(string args)

Parameters

Type	Name	Description
System.String	args	Value to convert.

Returns

Type	Description
System.String	Converted string.

ComputeValue(String)

Returns a number.

Declaration

public string ComputeValue(string range)

Parameters

Type	Name	Description
System.String	range	A date or number string.

Returns

Type	Description
System.String	returns a number.

ComputeVar(String)

Returns sample variance of the listed values.

Declaration

public string ComputeVar(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The sample variance.

ComputeVara(String)

Returns sample variance of the listed values.

Declaration

public string ComputeVara(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The sample variance.

Remarks

True is treated as 1 and False is treated as 0.

ComputeVarp(String)

Returns population variance of the listed values.

Declaration

public string ComputeVarp(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The population variance.

ComputeVarpa(String)

Returns population variance of the listed values.

Declaration

public string ComputeVarpa(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of: cell references, formulas, or numbers.

Returns

Type	Description
System.String	The population variance.

Remarks

True is treated as 1 and False is treated as 0.

ComputeVarPAdv(String)

Returns sample variance of the listed values.

Declaration

public string ComputeVarPAdv(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of cell references, formulas, or numbers.

Returns

Type	Description
System.String	The sample variance.

ComputeVarSAdv(String)

Calculates variance based on the entire population (ignores logical values and text in the population).

Declaration

public string ComputeVarSAdv(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of cell references, formulas, or numbers.

Returns

Type	Description
System.String	The sample variance.

ComputeVdb(String)

Computes the variable declining balance of an asset

Declaration

public string ComputeVdb(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the initial cost, salvage value, life of asset, period of calculation, factor.

Returns

Type	Description
System.String	Variable declining balance.

ComputeVLookUp(String)

Returns a vertical table look up value.

Declaration

public string ComputeVLookUp(string range)

Parameters

Type	Name	Description
System.String	range	Contains search value, table, return index and match properties.

Returns

Type	Description
System.String	Matching value found in the table.

Remarks

For example, =VLOOKUP("Axles",A1:C4,2,TRUE) looks for the exact match for Axles in A1:A4 and returns the corresponding value in B1:B4.

ComputeWebService(String)

Used to calculate the value of ComputeWebService function

Declaration

public string ComputeWebService(string argList)

Parameters

Type	Name	Description
System.String	argList	Represents the string values used in the function

Returns

Type
System.String

ComputeWeekday(String)

Day of the week.

Declaration

public string ComputeWeekday(string argList)

Parameters

Type	Name	Description
System.String	argList	Serial number date1 and return_type.

Returns

Type	Description
System.String	Days between the dates.

ComputeWeeknum(String)

Returns the week number of a specific date

Declaration

public string ComputeWeeknum(string argList)

Parameters

Type	Name	Description
System.String	argList	serial_number,start_day of week (optional)

Returns

Type	Description
System.String	returns the week number

ComputeWeibull(String)

Returns the Weibull distribution.

Declaration

public string ComputeWeibull(string argList)

Parameters

Type	Name	Description
System.String	argList	X, alpha, beta, cumulative.

Returns

Type	Description
System.String	Returns Weibull distribution.

ComputeWeiBullODist(String)

Calculates the Weibull Probability Density Function or the Weibull Cumulative Distribution Function for a supplied set of parameters.

Declaration

public string ComputeWeiBullODist(string argList)

Parameters

Type	Name	Description
System.String	argList	x, alpha, beta, cumulative.

Returns

Type	Description
System.String	Returns the calculated weibull distribution.

Remarks

cumulative = A logical argument which denotes the type of distribution to be used TRUE = Weibull Cumulative Distribution Function FALSE = Weibull Probability Density Function

ComputeWorkDay(String)

returns the date of the given date after the number of working days

Declaration

public string ComputeWorkDay(string argList)

Parameters

Type	Name	Description
System.String	argList	startDate, days, holidays (optional)

Returns

Type	Description
System.String	returns the date

ComputeWorkDayintl(String)

Returns the serial number of the given date before or after a specified number of workdays

Declaration

public string ComputeWorkDayintl(string argList)

Parameters

Type	Name	Description
System.String	argList	startDate, days, weekend (optional) , holidays (optional)

Returns

Type	Description
System.String	return the serial number of specific date.

ComputeXirr(String)

Computes the internal rate of return of a series of cash flows.

Declaration

public string ComputeXirr(string argList)

Parameters

Type	Name	Description
System.String	argList	values, dates, guess. Values and dates are ranges of cells holding the values and dates. Guess is the initial guess. The first date is the the start date for the calculation.

Returns

Type	Description
System.String	Internal rate of return.

Remarks

This XIRR calculation is similar to IRR except that the values are not equally spaced in time. The algorithm returns a value if the relative difference between root approximations is less than 1e-5. It fails if this accuracy is not attained in 20 iterations.

ComputeXor(String)

Returns the exclusive OR of all values treated as logical values listed in the argument.

Declaration

public string ComputeXor(string range)

Parameters

Type	Name	Description
System.String	range	A string holding a list (separated by commas) of cell references, formulas, or numbers. Each item in the list is considered True if it is nonzero and False if it is zero.

Returns

Type	Description
System.String	A string holding the exclusive OR of all values listed in the argument.

ComputeYear(String)

Returns the year of the given date.

Declaration

public string ComputeYear(string argList)

Parameters

Type	Name	Description
System.String	argList	Given date.

Returns

Type	Description
System.String	returns Month.

ComputeYearFrac(String)

returns the fraction of the year represented by the number of whole days between two given dates

Declaration

public string ComputeYearFrac(string argList)

Parameters

Type	Name	Description
System.String	argList	startDate, endDate, basis (optional)

Returns

Type	Description
System.String	returns the fraction of the year

ComputeZOtest(String)

Returns the one-tailed probability value of a Z test.

Declaration

public string ComputeZOtest(string range)

Parameters

Type	Name	Description
System.String	range	Range, mu, sigma.

Returns

Type	Description
System.String	Kth smallest value.

ComputeZtest(String)

Returns the one-tailed probability value of a Z test.

Declaration

public string ComputeZtest(string range)

Parameters

Type	Name	Description
System.String	range	Range, mu, sigma.

Returns

Type	Description
System.String	Kth smallest value.

Covariance(Double[], Double[], Double)

Returns the sample covariance between two arrays. Arrays should be of equal length, and contain more than one element.

Declaration

public double Covariance(double[] array1, double[] array2, double decayFactor)

Parameters

Type	Name	Description
System.Double[]	array1	The double array1
System.Double[]	array2	The double array2
System.Double	decayFactor	In most applications, the decay factor is between 0 and 1. Weigth on the last element in arrays is 1.0, the 2nd to last element d, 3rd to last d^2, ...

Returns

Type
System.Double

CreateSheetFamilyID()

Returns an integer that is used to identify a family of grids.

Declaration

public static int CreateSheetFamilyID()

Returns

Type	Description
System.Int32	return integer

Remarks

Essential Grid supports multisheet references within a family of grids. To use this functionality, you employ the method to get a unique identifier for the family. Then in the RegisterGridAsSheet method that you call to add grids to this family, you pass this unique identifier to mark the grids as belonging to this family. You can only cross reference grids within the same family.

Factorial(Int32)

Returns n! 0! = 1,otherwise n! = n * (n-1) * (n-2) * ... * 2 * 1,

Declaration

public static long Factorial(int n)

Parameters

Type	Name	Description
System.Int32	n

Returns

Type
System.Int64

getBetween(String, String, String)

Used to get the between string

Declaration

public static string getBetween(string strSource, string strStart, string strEnd)

Parameters

Type	Name	Description
System.String	strSource	Represents the source string
System.String	strStart	Represents the starting string
System.String	strEnd	Represents the ending string

Returns

Type
System.String

GetCellsFromArgs(String)

Accepts an argument string and returns a string array of cells.

Declaration

public string[] GetCellsFromArgs(string args)

Parameters

Type	Name	Description
System.String	args	String containing a cell range.

Returns

Type	Description
System.String[]	String array of cells.

Remarks

Converts arguments in these forms to a string array of individual cells.

A1,A2,B4,C1,...,D8

A1:A5

A1:C5

GetDataFromArgs(String)

Used to get the data from the datatable

Declaration

public DataTable GetDataFromArgs(string args)

Parameters

Type	Name	Description
System.String	args	The Arguments, it may be cell reference or cell range.

Returns

Type	Description
System.Data.DataTable	Returns data table holding data.

GetDateFromSerialDate(Int32)

Gets the date associated with a serial day number.

Declaration

public DateTime GetDateFromSerialDate(int serialDayNumber)

Parameters

Type	Name	Description
System.Int32	serialDayNumber	The serial day number.

Returns

Type	Description
System.DateTime	The date value.

Remarks

The serial day number is the number of days since January 1, 1900 with the serial day number of January 1, 1900 being counted as 1. The serial day number is how Excel stores dates. It is useful for including dates in calculations.

GetSerialDateFromDate(Int32, Int32, Int32)

Returns the serial day number for the given date.

Declaration

public int GetSerialDateFromDate(int y, int m, int d)

Parameters

Type	Name	Description
System.Int32	y	The year of the date.
System.Int32	m	The month of the date.
System.Int32	d	The day of the date.

Returns

Type	Description
System.Int32	The serial day number.

Remarks

The serial day number is the number of days since January 1, 1900 with the serial day number of January 1, 1900 being counted as 1. The serial day number is how Excel stores dates. It is useful for including dates in calculations.

GetSheetFamilyItem(GridModel)

Returns the GridSheetFamilyItem for the specified model. If there was no item registered for the model, a new item is created and cached.

Declaration

public static GridSheetFamilyItem GetSheetFamilyItem(GridModel model)

Parameters

Type	Name	Description
GridModel	model	The grid model.

Returns

Type	Description
GridSheetFamilyItem	The GridSheetFamilyItem for the specified model.

GetStringArray(String)

Returns an array of strings from an argument list.

Declaration

public string[] GetStringArray(string s)

Parameters

Type	Name	Description
System.String	s	A delimited argument list.

Returns

Type	Description
System.String[]	Array of strings from an argument list.

GetValueFromArg(String)

Computes the value contained in the argument.

Declaration

public string GetValueFromArg(string arg)

Parameters

Type	Name	Description
System.String	arg	A parsed formula, raw number, or cell reference.

Returns

Type	Description
System.String	A string with the computed number in it.

Remarks

This method takes the argument and checks whether it is a parsed formula, raw number, or cell reference like A21. The return value is a string that holds the computed value of the passed-in argument.

GetValueFromArg(String, Boolean)

Computes the value contained in the argument.

Declaration

public string GetValueFromArg(string arg, bool returnString)

Parameters

Type	Name	Description
System.String	arg	A parsed formula, raw number, or cell reference.
System.Boolean	returnString	If False, this method returns the empty string if the arg is a string. If True, this method will return the string value.

Returns

Type	Description
System.String	A string with the arg value in it.

Remarks

This method takes the argument and checks whether it is a parsed formula, raw number, or cell reference like A21. The return value is a string that holds the computed value of the passed-in argument.

GetValueFromGrid(Int32, Int32)

Conditionally gets either the formula value or the cell value depending upon whether the requested cell is a FormulaCell.

Declaration

public string GetValueFromGrid(int row, int col)

Parameters

Type	Name	Description
System.Int32	row	Row index of the requested cell.
System.Int32	col	Column index of the requested cell.

Returns

Type	Description
System.String	String holding either the cell value or the computed formula value.

Examples

This example shows how to get the cell value from the grid with the specified row and column index.

void gridControl1_CellClick(object sender, GridCellClickEventArgs e)
{
    // Gets the cell value from the given row index and column index.
    GridFormulaEngine calculateEngine = new GridFormulaEngine(this.gridControl1.Model);
    string cellValue = calculateEngine.GetValueFromGrid(e.RowIndex, e.ColIndex);
    Console.WriteLine("The Cell value is  " + cellValue);
}

Private Sub gridControl1_CellClick(ByVal sender As Object, ByVal e As GridCellClickEventArgs)
   ' Gets the cell value from the given row index and column index.
   Dim calculateEngine As New GridFormulaEngine(Me.gridControl1.Model)
   Dim cellValue As String = calculateEngine.GetValueFromGrid(e.RowIndex, e.ColIndex)
   Console.WriteLine("The Cell value is  " & cellValue)
End Sub

GetValueFromGrid(String)

Conditionally gets either the formula value or the cell value depending upon whether the requested cell is a FormulaCell.

Declaration

public string GetValueFromGrid(string cell1)

Parameters

Type	Name	Description
System.String	cell1	The alphanumeric cell label, like A1, or EE14.

Returns

Type	Description
System.String	String holding either the cell value or the computed formula value.

Examples

This example shows how to get the string value from the specified cell index.

// Gets the cell value from a particular cell index.
GridFormulaEngine calculateEngine = new GridFormulaEngine(this.gridControl1.Model);
string cellValue = calculateEngine.GetValueFromGrid("C33");
Console.WriteLine("The cell value is  " + cellValue);

' Gets the cell value from a particular cell index.
Dim calculateEngine As New GridFormulaEngine(Me.gridControl1.Model)
Dim cellValue As String = calculateEngine.GetValueFromGrid("C33")
Console.WriteLine("The cell value is  " & cellValue)

HalfLifeOfGeometricSeries(Double, Int32)

Returns the half-life of a geometric series of length n, who's first element is 1. For decay factor d, 1 + d + d^2 + ... + d^(h-1) = 0.5 * [1 + d + d^2 + ... + d^(n-1)]

Declaration

public static double HalfLifeOfGeometricSeries(double decayFactor, int length)

Parameters

Type	Name	Description
System.Double	decayFactor	Decay factor Typically between -1 adn +1.
System.Int32	length	Number of elements in the geometric series, must be positive.

Returns

Type
System.Double

IHProbDens(Double, Int32)

The Irwin-Hall distribution results from the sum on n independent standard uniform variables

Declaration

public static double IHProbDens(double x, int n)

Parameters

Type	Name	Description
System.Double	x	The value at which to evaluate the distribution.
System.Int32	n	The number of standard uniform variables.

Returns

Type
System.Double

InitLibraryFunctions()

Creates and initially loads the Function Library with the supported functions.

Declaration

public virtual void InitLibraryFunctions()

InverseSumOfGeometricSeries(Double, Int32)

Returns the inverse of the sum of a geometric series of length n, who's first element is 1. For decay factor d, S = 1 + d + d^2 + ... + d^(n-1). Return 1/S.

Declaration

public static double InverseSumOfGeometricSeries(double decayFactor, int length)

Parameters

Type	Name	Description
System.Double	decayFactor	Decay factor Typically between -1 adn +1.
System.Int32	length	Number of elements in the geometric series, must be positive.

Returns

Type
System.Double

IsCircularReference(String, String)

Determines whether the given formula at the given cell will cause a circular reference.

Declaration

public bool IsCircularReference(string cell, string formula)

Parameters

Type	Name	Description
System.String	cell	The alphanumeric cell label, like A1, or EE14.
System.String	formula	The formula to be tested.

Returns

Type	Description
System.Boolean	True if the given formula causes a circular reference, false otherwise.

IsDirty(GridFormulaTag)

Returns whether or not the calculation for this GridFormulaTag is current or not.

Declaration

public bool IsDirty(GridFormulaTag tag)

Parameters

Type	Name	Description
GridFormulaTag	tag	The GridFormulaTag to be tested.

Returns

Type	Description
System.Boolean	Returns true if the tag has been computed with the most recent values, false otherwise.

IsFormulaValid(String)

Checks if the given string holds a valid formula.

Declaration

public bool IsFormulaValid(string text)

Parameters

Type	Name	Description
System.String	text	String to be tested.

Returns

Type	Description
System.Boolean	True if string holds a valid formula, false otherwise.

IsFormulaValid(String, out String, out String, out String)

Checks if given string holds a valid formula.

Declaration

public bool IsFormulaValid(string text, out string parsedFormula, out string errorMessage, out string computedValue)

Parameters

Type	Name	Description
System.String	text	String to be tested.
System.String	parsedFormula	Tokenized string holding holding valid parsed formula.
System.String	errorMessage	Error message from the grid if string is invalid.
System.String	computedValue	Computed value from parsed formula.

Returns

Type	Description
System.Boolean	True if string holds a valid formula, false otherwise.

IsSeparatorInTIC(String)

Returns True if the ParseArgumentSeparator character is included in a string.

Declaration

public bool IsSeparatorInTIC(string s)

Parameters

Type	Name	Description
System.String	s	The string to be searched.

Returns

Type	Description
System.Boolean	True or False.

j0(String)

Returns the Bessel function of order 0 of the specified number.

Declaration

public static double j0(string x)

Parameters

Type	Name	Description
System.String	x	Input number.

Returns

Type	Description
System.Double	Returns the Bessel function of order 1 of the specified number.

j1(String)

Returns the Bessel function of order 1 of the specified number.

Declaration

public static double j1(string x)

Parameters

Type	Name	Description
System.String	x	Input number.

Returns

Type	Description
System.Double	Returns the Bessel function of order 1 of the specified number.

Mean(Double[])

Returns the mean of an array.

Declaration

public double Mean(double[] array)

Parameters

Type	Name	Description
System.Double[]	array	Array of data for which we are calculating the mean.

Returns

Type
System.Double

Examples

This example shows how to get the mean of given array of values.

GridFormulaEngine calculateEngine = new GridFormulaEngine(this.gridControl1.Model);
double[] arr = { 4, 7, 9, 14, 23, 56 }; double q = 1;
// Computes the mean value of given numbers.
this.gridControl1[5, 5].CellValue = calculateEngine.Mean(arr);
Console.WriteLine("The mean of array values are  " + this.gridControl1[5, 5].CellValue);

Dim calculateEngine As New GridFormulaEngine(Me.gridControl1.Model)
Dim arr() As Double = { 4, 7, 9, 14, 23, 56 }
Dim q As Double = 1
' Computes the mean value of given numbers.
Me.gridControl1(5, 5).CellValue = calculateEngine.Mean(arr)
Console.WriteLine("The mean of array values are  " & Me.gridControl1(5, 5).CellValue)

Mean(Double[], Double)

Returns the mean of an array.

Declaration

public static double Mean(double[] array, double decayFactor)

Parameters

Type	Name	Description
System.Double[]	array	Array of data for which we are calculating the mean. For time series, the last element (index = n-1), is the most recent.
System.Double	decayFactor	In most applications, the decay factor is between 0 and 1. Weight on the last element in array is 1.0, the 2nd to last element d, 3rd to last d^2, ...

Returns

Type
System.Double

Mean(Double[], Double, Int32)

Returns the mean of an array.

Declaration

public double Mean(double[] array, double decayFactor, int length)

Parameters

Type	Name	Description
System.Double[]	array	Array of data for which we are calculating the mean. For time series, the last element (index = n-1), is the most recent.
System.Double	decayFactor	In most applications, the decay factor is between 0 and 1. Weight on the last element in array is 1.0, the 2nd to last element d, 3rd to last d^2, ...
System.Int32	length	Window length. Method uses the most recent n points, n = length.

Returns

Type
System.Double

Examples

This example shows how to get the mean of given array values and specifying it's decay factor.

Dim calculateEngine As New GridFormulaEngine(Me.gridControl1.Model)
Dim arr() As Double = { 4, 7, 9, 14, 23, 56 }
' Computes the mean value of given numbers.
Me.gridControl1(5, 5).CellValue = calculateEngine.Mean(arr,1,2)
Console.WriteLine("The mean of array values are  " & Me.gridControl1(5, 5).CellValue)

MostRecentValues(Double[], Int32)

Returns the most recent points from an array (the points with the highest index values). For functions with a decay factor, the weight on the last element in the array is the highest. In many applications this corresponds with the assumption that the last element in the array represents the most recent data point.

Declaration

public static double[] MostRecentValues(double[] inArray, int length)

Parameters

Type	Name	Description
System.Double[]	inArray	Array from which the data points will be selected.
System.Int32	length	The number of data points to be returned.

Returns

Type
System.Double[]

Parse(String)

Parses a formula string into a tokenized string.

Declaration

public string Parse(string text)

Parameters

Type	Name	Description
System.String	text	The string to be parsed.

Returns

Type	Description
System.String	The parsed string.

Remarks

This method accepts a string that holds a formula, like =Sum(A1:B5), and translates this string into a tokenized expression that can be computed using the ComputedValue method. Before calling the method, you should set FormulaContextCell to properly reflect which cell owns this formula. The return value, which is the tokenized string, is referred to as a parsed formula string.

Examples

This example shows how to parse the given formula text.

GridFormulaEngine calculateEngine = new GridFormulaEngine(this.gridControl1.Model);
// Parses the given string.
string parsedFormula = calculateEngine.Parse("=(29-7)+56");
Console.WriteLine("The parsed formula string is  " + parsedFormula);

Dim calculateEngine As New GridFormulaEngine(Me.gridControl1.Model)
' Parses the given string.
Dim parsedFormula As String = calculateEngine.Parse("=(29-7)+56")
Console.WriteLine("The parsed formula string is  " & parsedFormula)

RecalculateHiddenRange(GridRangeInfo, Int32)

Recalculates formula based on the hidden range.

Declaration

public void RecalculateHiddenRange(GridRangeInfo range, int colOffSet)

Parameters

Type	Name	Description
GridRangeInfo	range	GridRangeInfo object that specifies the cells to be recalculated.
System.Int32	colOffSet	Column adjutancy range for the formula cell.

RecalculateHiddenRange(Int32, GridRangeInfo)

Recalculates formula based on the hidden range.

Declaration

public void RecalculateHiddenRange(int rowOffSet, GridRangeInfo range)

Parameters

Type	Name	Description
System.Int32	rowOffSet	Row adjutancy range for the formula cell.
GridRangeInfo	range	GridRangeInfo object that specifies the cells to be recalculated.

RecalculateRange(GridRangeInfo)

Recalculates any formula cells in the specified range.

Declaration

public void RecalculateRange(GridRangeInfo range)

Parameters

Type	Name	Description
GridRangeInfo	range	GridRangeInfo object that specifies the cells to be recalculated.

Remarks

The calculations for non-visible formula cells are performed the next time cell are actually displayed. If you want the calculation performed immediately on cells (visible or not), call the two argument overload of RecalculateRange, passing the forceCalculations argument as True.

RecalculateRange(GridRangeInfo, GridModel, Boolean, Boolean)

Recalculates any formula cells in the specified range.

Declaration

public void RecalculateRange(GridRangeInfo range, GridModel grd, bool forceCalculations, bool forceParsing)

Parameters

Type	Name	Description
GridRangeInfo	range	GridRangInfo object that specifies the cells to be recalculated.
GridModel	grd	The GridModel object where the range to be updated is located.
System.Boolean	forceCalculations	Determines whether the calculations on non-visible cells are performed immediately or delayed until the next time the cell is drawn. For visible cells, the calculations are done immediately.
System.Boolean	forceParsing	When forceParsing is False, a formula is only re-parsed if FormulaTag is NULL, or FormulaTag.Formula is empty. Otherwise, the existing parsed formula in FormulaTag.Formula is used to perform the calculation. The value of forceParsing only affects the Engine if forceCalculations is True.

Remarks

This method does not do anything if CalculatingSuspended is True.

RecalculateRange(GridRangeInfo, Boolean)

Recalculates any formula cells in the specified range.

Declaration

public void RecalculateRange(GridRangeInfo range, bool forceCalculations)

Parameters

Type	Name	Description
GridRangeInfo	range	GridRangeInfo object that specifies the cells to be recalculated.
System.Boolean	forceCalculations	Determines whether the calculations on non-visible cells are performed immediately or delayed until the next time the cell is drawn. For visible cells, the calculations are done immediately.

RecalculateRange(GridRangeInfo, Boolean, Boolean)

Recalculates any formula cells in the specified range.

Declaration

public void RecalculateRange(GridRangeInfo range, bool forceCalculations, bool forceParsing)

Parameters

Type	Name	Description
GridRangeInfo	range	GridRangeInfo object that specifies the cells to be recalculated.
System.Boolean	forceCalculations	Determines whether the calculations on non-visible cells are performed immediately or delayed until the next time the cell is drawn. For visible cells, the calculations are done immediately.
System.Boolean	forceParsing	When forceParsing is False, a formula is only re-parsed if FormulaTag is NULL, or FormulaTag.Formula is empty. Otherwise, the existing parsed formula in FormulaTag.Formula is used to perform the calculation. The value of forceParsing only affects the Engine if forceCalculations is True.

Remarks

This method does not do anything if CalculatingSuspended is true.

Refresh(String)

Recalculates any cell that depends upon the passed in cell.

Declaration

public void Refresh(string s)

Parameters

Type	Name	Description
System.String	s	A cell such as A21 or EE31.

RefreshRange(GridRangeInfo)

Recalculates every cell that depends upon any cell in the passed-in range.

Declaration

public void RefreshRange(GridRangeInfo range)

Parameters

Type	Name	Description
GridRangeInfo	range	GridRangeInfo object to be refreshed.

Remarks

For example, if range is GridRangeInfo(1,1,2,2), and cells (5,6) and (12,17) hold formulas that reference the cells in the range, then cells (5,6) and (12,17) will be re-computed as the result of this call.

RegisterGridAsSheet(String, GridModel, Int32)

Registers a grid so it can be referenced in a formula from another grid.

Declaration

public static void RegisterGridAsSheet(string refName, GridModel model, int sheetFamilyID)

Parameters

Type	Name	Description
System.String	refName	The reference name used to refer to this grid from formulas in other grids.
GridModel	model	The GridModel from the grid being registered.
System.Int32	sheetFamilyID	An integer previously created with a call to GridFormulaEngine.CreateSheetFamilyID. This number is used to identify the grids as belonging to a particular family of grids. You can only reference grids from within the same family.

Remarks

Essential Grid supports multisheet references with its formulas. For example, if you have two tabpages with a GridControl on each, you can reference cells from the first in the second grid. For this to work, both grids need to be registered using this method.

The syntax for using a sheet reference as part of a formula is to prefix a cell reference with the sheet reference name followed by an exclamation point.

The formula "= sheet1!A1 + sheet2!C3" would add the value of cell A1 for the grid whose reference name is sheet1 to the value from cell C3 in the grid whose reference name is sheet2.

Examples

Use this code to use cross sheet references.

       //Register 3 grids so cell can be referenced across grids.
       int sheetfamilyID = GridFormulaEngine.CreateSheetFamilyID();
       GridFormulaEngine.RegisterGridAsSheet("summary", this.gridControl1.Model, sheetfamilyID);
       GridFormulaEngine.RegisterGridAsSheet("income", this.gridControl2.Model, sheetfamilyID);
       GridFormulaEngine.RegisterGridAsSheet("expenses", this.gridControl3.Model, sheetfamilyID);
       ....
       //Sample formula usage for cells in gridControl1, the 'summary' grid.
       //This code sums up some cells from gridControl3, the 'expenses' grid, 
       //and gridControl2, the 'income' grid.
       
      //Sum the range B2:B8 from the expenses grid.
      this.gridControl1[3,4].Text = "= Sum(expenses!B2:expenses!B8)";

       //Sum the range B2:B4 from the income grid.
       this.gridControl1[4,4].Text = "= Sum(income!B2:income!B4)";
       

       'Register 3 grids so cells can be referenced across grids.
       Dim sheetfamilyID As Integer = GridFormulaEngine.CreateSheetFamilyID();
       GridFormulaEngine.RegisterGridAsSheet("summary", Me.gridControl1.Model, sheetfamilyID)
       GridFormulaEngine.RegisterGridAsSheet("income", Me.gridControl2.Model, sheetfamilyID) 
       GridFormulaEngine.RegisterGridAsSheet("expenses", Me.gridControl3.Model, sheetfamilyID) 
       ....
       'Sample formula usage for cells in gridControl1, the 'summary' grid.
       'This code sums ups some cells from gridControl3, the 'expenses' grid, 
       'and gridControl2, the 'income' grid.
      
     'Sum the range B2:B8 from the expenses grid.
     Me.gridControl1(3,4).Text = "= Sum(expenses!B2:expenses!B8)"

       'Sum the range B2:B4 from the income grid.
       Me.gridControl1(4,4).Text = "= Sum(income!B2:income!B4)"

RemoveFunction(String)

Removes a function from the Function Library.

Declaration

public bool RemoveFunction(string name)

Parameters

Type	Name	Description
System.String	name	The name of the function to be removed.

Returns

Type	Description
System.Boolean	True if successfully removed, False otherwise.

Examples

This example shows how to remove the function from the library.

// Removes the function from the library.
GridFormulaEngine calculateEngine = new GridFormulaEngine(this.gridControl1.Model);
calculateEngine.RemoveFunction("Sum");

' Removes the function from the library.
Dim calculateEngine As New GridFormulaEngine(Me.gridControl1.Model)
calculateEngine.RemoveFunction("Sum")

RemoveGridSheet(String, GridModel)

Removes a sheet from a sheet family.

Declaration

public static void RemoveGridSheet(string sheetName, GridModel grid)

Parameters

Type	Name	Description
System.String	sheetName	The name of the sheet to be removed.
GridModel	grid	The GridModel associated with this sheet.

Remarks

This method only updates the GridFormulaEngine structure with respect to removing a sheet from a family of sheets that has been created using RegisterGridAsSheet(String, GridModel, Int32).

This procedure first renames the sheet to be deleted as #REF using Syncfusion.Windows.Forms.Grid.GridFormulaEngine.ChangeGridSheetName(System.String,System.String,Syncfusion.Windows.Forms.Grid.GridModel,System.Boolean). This has the effect of replacing any formula on another sheet that references this deleted sheet with a #REF to indicate that formula has a reference problem. It will then call UnregisterGridAsSheet(String, GridModel) with the new name #REF to remove the renamed sheet.

This method does not remove the grid from your UI structures. For example, if you have several grids in a TabControl, calling RemoveGridSheet does not remove the grid from any tabpage.

RemoveNamedRange(String)

Removes a range from the namedranges collection.

Declaration

public bool RemoveNamedRange(string name)

Parameters

Type	Name	Description
System.String	name	The name of the range to be removed.

Returns

Type	Description
System.Boolean	True is successfully remove, False otherwise.

Examples

This example shows how to remove the NamedRange with the specified key from the NamedRangeCollection.

// Removes the named range from the collection.
GridFormulaEngine calculateEngine = new GridFormulaEngine(this.gridControl1.Model);
calculateEngine.RemoveNamedRange("A");

' Removes the named range from the collection.
Dim calculateEngine As New GridFormulaEngine(Me.gridControl1.Model)
calculateEngine.RemoveNamedRange("A")

RemoveNamedRangeDependency(String)

Removes entries in the DependentNamedRangeCells collection for the given named range.

Declaration

public void RemoveNamedRangeDependency(string key)

Parameters

Type	Name	Description
System.String	key	The named range.

RowIndex(String)

Returns the row index from a cell reference.

Declaration

public int RowIndex(string s)

Parameters

Type	Name	Description
System.String	s	String holding a cell reference such as C21 or AB11.

Returns

Type	Description
System.Int32	An integer with the corresponding row number.

SetDirty(GridFormulaTag)

Marks the underlying formula as dirty, indicating it needs to be recomputed. It does this by setting the Text property to null.

Declaration

public void SetDirty(GridFormulaTag tag)

Parameters

Type	Name	Description
GridFormulaTag	tag	The GridFormulaTag to be marked as not computed.

SetNamedRangeDependency(String, String)

Adds a cell to the DependentNamedRangeCells list.

Declaration

public void SetNamedRangeDependency(string key, string cell1)

Parameters

Type	Name	Description
System.String	key	The named range.
System.String	cell1	The cell (such as C11 or AJ232).

StandardNormalCumulativeDistribution(Double)

Returns the CDF of the standard normal distribution.

Declaration

public double StandardNormalCumulativeDistribution(double x)

Parameters

Type	Name	Description
System.Double	x	Value at which the distribution is evaluated.

Returns

Type
System.Double

StandardNormalCumulativeDistributionFunction(Double)

Returns the CDF of the standard normal distribution.

Declaration

public double StandardNormalCumulativeDistributionFunction(double x)

Parameters

Type	Name	Description
System.Double	x	Value at which the distribution is evaluated.

Returns

Type
System.Double

StandardNormalCumulativeDistributionFunctionInverse(Double)

Returns the inverse of the CDF of the standard normal distribution.

Declaration

public double StandardNormalCumulativeDistributionFunctionInverse(double p)

Parameters

Type	Name	Description
System.Double	p	Cumulative probability of the distribution. p is between 0 and 1.

Returns

Type
System.Double

StandardNormalCumulativeDistributionInverse(Double)

Returns the inverse of the CDF of the standard normal distribution.

Declaration

public double StandardNormalCumulativeDistributionInverse(double p)

Parameters

Type	Name	Description
System.Double	p	Cumulative probability of the distribution. p is between 0 and 1.

Returns

Type
System.Double

StandardNormalProbabilityDensity(Double)

Returns the PDF of the standard normal distribution.

Declaration

public double StandardNormalProbabilityDensity(double x)

Parameters

Type	Name	Description
System.Double	x	Value at which the distribution is evaluated.

Returns

Type
System.Double

SumOfGeometricSeries(Double, Int32)

Returns the sum of a geometric series of length n, who's first element is 1. For decay factor d, S = 1 + d + d^2 + ... + d^(n-1)

Declaration

public static double SumOfGeometricSeries(double decayFactor, int length)

Parameters

Type	Name	Description
System.Double	decayFactor	Decay factor Typically between -1 adn +1.
System.Int32	length	Number of elements in the geometric series, must be positive.

Returns

Type
System.Double

SumOfInfiniteGeometricSeries(Double)

Returns the sum of an infinite geometric series who's first element is 1. For decay factor d, S = 1 + d + d^2 + ...

Declaration

public static double SumOfInfiniteGeometricSeries(double decayFactor)

Parameters

Type	Name	Description
System.Double	decayFactor	Decay factor. Typically between -1 adn +1.

Returns

Type
System.Double

ToString()

Displays information on the cell currently being calculated.

Declaration

public override string ToString()

Returns

Type	Description
System.String	String with information on the cell currently being calculated.

Overrides

System.Object.ToString()

TranslateText(String, String)

Used to convert the text

Declaration

public string TranslateText(string input, string languagePair)

Parameters

Type	Name	Description
System.String	input	Represents input string
System.String	languagePair	Represents the language pair

Returns

Type
System.String

TryParse(String, Int32, String, out Int32)

Used to parse the string

Declaration

public static bool TryParse(string s, int radix, string digits, out int result)

Parameters

Type	Name	Description
System.String	s	Represents the input
System.Int32	radix	Represents the radix value
System.String	digits	Represents the digits
System.Int32	result	Represents the output

Returns

Type
System.Boolean

UniformCumulativeDensityFunction(Double, Double, Double)

Returns the CDF of the uniform distribution.

Declaration

public static double UniformCumulativeDensityFunction(double x, double min, double max)

Parameters

Type	Name	Description
System.Double	x	Value at which the distribution is evaluated.
System.Double	min	Minimum value of the distribution.
System.Double	max	Maximum value of the distribution.

Returns

Type
System.Double

UniProbDens(Double, Double, Double)

Returns the PDF of the uniform distribution.

Declaration

public static double UniProbDens(double x, double min, double max)

Parameters

Type	Name	Description
System.Double	x	Value at which the distribution is evaluated.
System.Double	min	Minimum value of the distribution.
System.Double	max	Maximum value of the distribution.

Returns

Type
System.Double

UnregisterGridAsSheet(String, GridModel)

Unregisters a grid so it can no longer be referenced in a formula from another grid.

Declaration

public static void UnregisterGridAsSheet(string refName, GridModel model)

Parameters

Type	Name	Description
System.String	refName	The reference name used to refer to this grid from formulas in other grids.
GridModel	model	The grid model.

UpdateDependentNamedRangeCell(String)

Updates all cells that depend upon the given named range.

Declaration

public void UpdateDependentNamedRangeCell(string key)

Parameters

Type	Name	Description
System.String	key	The named range whose cells should be updated.

WeightedMean(Double[], Double[])

Returns the weighted averages of the values in valueArray using the corresponding weights in weightArray.

Declaration

public double WeightedMean(double[] valueArray, double[] weightArray)

Parameters

Type	Name	Description
System.Double[]	valueArray	array of values for which we are computing the weighted average
System.Double[]	weightArray	array of weights used in computing the weighted average

Returns

Type
System.Double

y0(Double)

Returns the Bessel function of the second kind, of order 0 of the specified number.

Declaration

public static double y0(double x)

Parameters

Type	Name	Description
System.Double	x	Input number.

Returns

Type	Description
System.Double	Returns the Bessel function of second kind, of order 0 of the specified number.

y1(Double)

Returns the Bessel function of the second kind, of order 1 of the specified number.

Declaration

public static double y1(double x)

Parameters

Type	Name	Description
System.Double	x	Input number.

Returns

Type	Description
System.Double	Returns the Bessel function of second kind, of order 1 of the specified number.

Events

FormulaParsing

Occurs whenever a string needs to be tested to determine whether it should be treated as a formula string and parsed, or be treated as a non-formula string. This event allows for preprocessing the unparsed formula.

Declaration

public event GridFormulaParsingEventHandler FormulaParsing

Event Type

Type
GridFormulaParsingEventHandler

Remarks

This event may be raised more than once in the processing of a string into a formula.