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
NonFinalizeDisposable
Disposable
GridFormulaEngine
Implements
System.IDisposable
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.Controls.Grid
Assembly: Syncfusion.Grid.Wpf.dll
Syntax
public class GridFormulaEngine : Disposable, IDisposable

Constructors

GridFormulaEngine(GridModel)

Constructor.

Declaration
public GridFormulaEngine(GridModel gridModel)
Parameters
Type Name Description
GridModel gridModel

The GridModel from the underlying grid.

Fields

ACC

Declaration
public double ACC
Field Value
Type
System.Double

BIGNI

Declaration
public double BIGNI
Field Value
Type
System.Double

BIGNO

Declaration
public double BIGNO
Field Value
Type
System.Double

cell

Declaration
public string cell
Field Value
Type
System.String

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
	};

machineepsilon

Declaration
public const double machineepsilon = 5E-16
Field Value
Type
System.Double

maxrealnumber

Declaration
public const double maxrealnumber = 1E+300
Field Value
Type
System.Double

minrealnumber

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

Treat1900AsLeapYear

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

Declaration
public static bool Treat1900AsLeapYear
Field Value
Type
System.Boolean

ValidSheetChars

Declaration
[ThreadStatic]
public static string ValidSheetChars
Field Value
Type
System.String

Properties

ActiveFunctionName

Returns 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 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

Indicates 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 GridCellFormulaModel.CalculatingSuspended.

CloneableFormulaTags

Gets / sets 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

Enables / disables 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.

DependentCells

Contains 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 = ((GridCellFormulaModel)this.gridControl1.Model.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("");
	}
}
	Public Sub DisplayAllAffectedCells()
		Dim engine As GridFormulaEngine = CType(Me.gridControl1.Model.CellModels("FormulaCell"), GridCellFormulaModel).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("")
		Next o
	End Sub 'DisplayAllAffectedCells

DependentFormulaCells

Contains 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 = ((GridCellFormulaModel)this.gridControl1.Model.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("");
		}
	}
	Public Sub DisplayAllFormulaDependencies()
		Dim engine As GridFormulaEngine = CType(Me.gridControl1.CellModels("FormulaCell"), GridCellFormulaModel).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("")
		Next o
	End Sub 'DisplayAllFormulaDependencies

DependentNamedRangeCells

Holds 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 whether circular references should be checked in the CurrentCell.Validating event.

Declaration
public bool DoCircularCheckInValidating { get; set; }
Property Value
Type
System.Boolean

EnsureIFCallDuringShortCircuit

Gets or sets whether the IF function implementation is called when AllowShortCircuitIFs is true. The default behavior is to not call the IF Function code in the library, but instead, work directly with the IF clauses.

Declaration
public bool EnsureIFCallDuringShortCircuit { get; set; }
Property Value
Type
System.Boolean

ErrorStrings

Declaration
public ArrayList ErrorStrings { get; set; }
Property Value
Type
System.Collections.ArrayList

FixedReferenceOnlyOnPaste

Determines 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 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.

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.

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 = "";
	foreach(string r in args.Split(new char[]{','}))
	{
		if(r.IndexOf(':') > -1) //is a cellrange
		{
			foreach(string s in engine.GetCellsFromArgs(r))
			{
				var s1 = engine.GetValueFromArg(s).Replace("'","");
				//... 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 = ""
   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)
				var s1 = engine.GetValueFromArg(s).Replace("'", "")
				'... do some calculations to compute sum
			Next s 
		End If
   Next r
   Return sum.ToString()
End Function 'ComputeSumPosNums

LibraryFunctions

Contains 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.

MaximumCircularChecks

Gets / 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

Specifies 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

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.

Model

Declaration
public GridModel Model { get; }
Property Value
Type
GridModel

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.

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

Holds namedranges in order of string length.

Declaration
protected ArrayList NamedRangesSized { get; }
Property Value
Type
System.Collections.ArrayList

SupportBlanksInSheetNames

Gets or sets 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

UseCommonLibrary

Gets or sets 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

UseDatesInCalculations

Gets or sets whether dates can be used as operands in calculations. The default value is false.

Declaration
public bool UseDatesInCalculations { get; set; }
Property Value
Type
System.Boolean

UseNoAmpersandQuotes

Gets or sets 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

Indicates 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

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);

AddNamedRange(String, String, String)

Adds a named range to the namedranges collection.

Declaration
public bool AddNamedRange(string name, string range, string scope)
Parameters
Type Name Description
System.String name

The name of the range to be added.
System.String range

The range to be added.
System.String scope
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.

AdjustRangeArg(ref String)

Accepts a possible parsed formula and returns the calculated value without quotes.

Declaration
public void AdjustRangeArg(ref string range)
Parameters
Type Name Description
System.String range

The argument to be adjusted.
Remarks

This method is useful in custom functions if you want to allow your custom functions to handle parsed formulas as arguments. In this case, calling this method at the beginning of your custom function will allow you custom function to work only with computed values, and not have to handle parsed formulas directly.

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)

Declaration
public string BaseToBase(string argList, int from, int to)
Parameters
Type Name Description
System.String argList
System.Int32 from
System.Int32 to
Returns
Type
System.String

besseli0(Double)

Declaration
public static double besseli0(double x)
Parameters
Type Name Description
System.Double x
Returns
Type
System.Double

BitAnd(String)

Declaration
public string BitAnd(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

BitLShift(String)

Computes the Bit Left Shift of the given number.

Declaration
public string BitLShift(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.

BitRShift(String)

Computes the Bit Right Shift of the given number.

Declaration
public string BitRShift(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.

BitXor(String)

Computes the Bit XoR of the given two numbers.

Declaration
public string BitXor(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.

ChangeGridSheetName(String, String, GridModel)

Changes a sheetname 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

The grid model.
Returns
Type Description
System.Boolean

True if the sheet was successfully renamed. If false returns, check whether the sheet family already contains the new name.

ChangeName(String, String, GridModel)

Declaration
public static void ChangeName(string oldName, string newName, GridModel grid)
Parameters
Type Name Description
System.String oldName
System.String newName
GridModel grid

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
System.Double

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.

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

ACosh(value).

ComputeAcot(String)

Declaration
public string ComputeAcot(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeAcoth(String)

Declaration
public string ComputeAcoth(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeAddress(String)

Declaration
public string ComputeAddress(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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)

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)

Changes full-width characters to half-width characters.

Declaration
public string ComputeAsc(string args)
Parameters
Type Name Description
System.String args

Value to convert.
Returns
Type Description
System.String

Converted string.

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

Value.
Returns
Type Description
System.String

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

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.

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.

ComputeAvg(String, Boolean)

Declaration
public string ComputeAvg(string range, bool calculateHiddenRange)
Parameters
Type Name Description
System.String range
System.Boolean calculateHiddenRange
Returns
Type
System.String

ComputeBase(String)

Declaration
public string ComputeBase(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeBesselI(String)

Declaration
public string ComputeBesselI(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeBesselJ(String)

Declaration
public string ComputeBesselJ(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputebesselK(String)

Declaration
public string ComputebesselK(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeBesselY(String)

Declaration
public string ComputeBesselY(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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 the 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.

ComputeBinToDec(String)

Declaration
public string ComputeBinToDec(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeBinToHex(String)

Declaration
public string ComputeBinToHex(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeBinToOct(String)

Computes the Octal Number for the given binary NUmber.

Declaration
public string ComputeBinToOct(string argList)
Parameters
Type Name Description
System.String argList

Input BinaryNumber
Returns
Type Description
System.String

The resultant Octal 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.

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)

Declaration
public string ComputeCeilingMath(string args)
Parameters
Type Name Description
System.String args
Returns
Type
System.String

ComputeCell(String)

Return the information about cell

Declaration
public string ComputeCell(string arg)
Parameters
Type Name Description
System.String arg

content, reference
Returns
Type Description
System.String

Cell information

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 the 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 the inverse of the chi-squared distribution.

ComputeChisqOdistORt(String)

Declaration
public string ComputeChisqOdistORt(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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)

Declaration
public string ComputeChisqOTest(string range)
Parameters
Type Name Description
System.String range
Returns
Type
System.String

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

y-intercept.

ComputeCode(String)

Declaration
public string ComputeCode(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeColumn(String)

Declaration
public string ComputeColumn(string args)
Parameters
Type Name Description
System.String args
Returns
Type
System.String

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)

Declaration
public string ComputeCombinA(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeComplex(String)

Declaration
public string ComputeComplex(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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)

Declaration
public string ComputeConfidenceT(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeConversion(String)

Declaration
public string ComputeConversion(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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.

ComputeCount(String, Boolean)

Declaration
public string ComputeCount(string range, bool calculateHiddenRange)
Parameters
Type Name Description
System.String range
System.Boolean calculateHiddenRange
Returns
Type
System.String

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.

ComputeCounta(String, Boolean)

Declaration
public string ComputeCounta(string range, bool calculateHiddenRange)
Parameters
Type Name Description
System.String range
System.Boolean calculateHiddenRange
Returns
Type
System.String

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

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

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)

Declaration
public string ComputeCUMIPMT(string args)
Parameters
Type Name Description
System.String args
Returns
Type
System.String

ComputeCUMPRINC(String)

Declaration
public string ComputeCUMPRINC(string args)
Parameters
Type Name Description
System.String args
Returns
Type
System.String

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

Day.

ComputeDAYS(String)

Declaration
public string ComputeDAYS(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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

Declining balance.

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

Double declining balance.

ComputeDecimal(String)

Declaration
public string ComputeDecimal(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeDecToBin(String)

Declaration
public string ComputeDecToBin(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeDecToHex(String)

Computes the Hexadecimal value for the given Decimal Number.

Declaration
public string ComputeDecToHex(string argList)
Parameters
Type Name Description
System.String argList

Data to be converted.
Returns
Type Description
System.String

Returns the calculated Hexadecimal value.

ComputeDecToOct(String)

Computes the Octal value for the given Decimal Number.

Declaration
public string ComputeDecToOct(string argList)
Parameters
Type Name Description
System.String argList

data to be converted.
Returns
Type Description
System.String

Returns the calculated Octal value.

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

Degrees.

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

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)

Declaration
public string ComputeDollarFr(string args)
Parameters
Type Name Description
System.String args
Returns
Type
System.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)

Declaration
public string ComputeEDATE(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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)

Declaration
public string ComputeEOMONTH(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeErf(String)

Declaration
public string ComputeErf(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeErfCPrecise(String)

Declaration
public string ComputeErfCPrecise(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeErfPrecise(String)

Declaration
public string ComputeErfPrecise(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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 range)
Parameters
Type Name Description
System.String range
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 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.

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

x.
Returns
Type Description
System.String

x!.

ComputeFactDouble(String)

Declaration
public string ComputeFactDouble(string argsList)
Parameters
Type Name Description
System.String argsList
Returns
Type
System.String

ComputeFalse(String)

Returns the logical value False.

Declaration
public string ComputeFalse(string empty)
Parameters
Type Name Description
System.String empty

Empty string.
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)

Filter the value from XML document

Declaration
public string ComputeFILTERXML(string argList)
Parameters
Type Name Description
System.String argList

XML content
Returns
Type Description
System.String

value

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.

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

Forecasted.

ComputeFORMULATEXT(String)

Declaration
public string ComputeFORMULATEXT(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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

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 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.

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 the natural logarithm of the 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)

Declaration
public string ComputeGCD(string range)
Parameters
Type Name Description
System.String range
Returns
Type
System.String

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.

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.

ComputeHexToBin(String)

Computes the Binary value for the given Hexadecimal Data.

Declaration
public string ComputeHexToBin(string argList)
Parameters
Type Name Description
System.String argList

Data to be converted.
Returns
Type Description
System.String

Returns the calculated Binary value.

ComputeHexToDec(String)

Computes the Decimal Equivalent for the given Hexadecimal value

Declaration
public string ComputeHexToDec(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.

ComputeHexToOct(String)

Computes the Octal Equivalent for the given Hexadecimal value

Declaration
public string ComputeHexToOct(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

Hour.

ComputeHYPERLINK(String)

Declaration
public string ComputeHYPERLINK(string argList)
Parameters
Type Name Description
System.String argList
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.

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

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
Returns
Type
System.String

ComputeImABS(String)

Declaration
public string ComputeImABS(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeImaginary(String)

Declaration
public string ComputeImaginary(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeImaginaryArgument(String)

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

Declaration
public string ComputeImaginaryArgument(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

ComputeImaginaryDifference(String)

Declaration
public string ComputeImaginaryDifference(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeImaginarySum(String)

Declaration
public string ComputeImaginarySum(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeImCos(String)

Declaration
public string ComputeImCos(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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)

Declaration
public string ComputeImCot(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeIMCSCH(String)

Declaration
public string ComputeIMCSCH(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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.

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.

ComputeImSin(String)

Declaration
public string ComputeImSin(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeImSinH(String)

Declaration
public string ComputeImSinH(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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.

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)

Declaration
public string ComputeINFO(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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

y-intercept.

ComputeIntrate(String)

Returns the interest rate for a fully invested security.

Declaration
public string ComputeIntrate(string argList)
Parameters
Type Name Description
System.String argList
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
System.String

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 given string is Even number or Not.

Declaration
public string ComputeIsEven(string range)
Parameters
Type Name Description
System.String range

A string to be tested.
Returns
Type Description
System.String

TRUE if the string is Even Number, otherwise returns False

ComputeIsFormula(String)

Declaration
public string ComputeIsFormula(string argList)
Parameters
Type Name Description
System.String argList
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 wheather the String contains Odd Number or Not.

Declaration
public string ComputeIsOdd(string range)
Parameters
Type Name Description
System.String range

A string to be tested
Returns
Type Description
System.String

Returns True if the value in the range is Odd otherwise returns False

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

Interest payment.

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)

Declaration
public string ComputeJis(string arg)
Parameters
Type Name Description
System.String arg
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

Range, k.
Returns
Type Description
System.String

Kth largest value.

ComputeLCM(String)

Declaration
public string ComputeLCM(string range)
Parameters
Type Name Description
System.String range
Returns
Type
System.String

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

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.

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 the 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.

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.

ComputeMatch(String)

Finds the index a specified value in a lookup_range.

Declaration
public string ComputeMatch(string arg)
Parameters
Type Name Description
System.String arg

look_value, lookup_range, match_type
Returns
Type Description
System.String

The relative index of the lookup_value in the lookup_range.
Remarks

Lookup_range should be a either a single row range or a single column range. If match_type is 0, the relative index of the first exact match (ignoring case) in the specified range is returned. If match_type is 1, the values in the range should be in ascending order, and the index of the largest value less than or equal to the lookup_value is returned. If match_type is -1, the values in the range should be in descending order, and the index of the smallest value greater than or equal to the lookup_value is returned.

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.

ComputeMax(String, Boolean)

Declaration
public string ComputeMax(string range, bool calculateHiddenRange)
Parameters
Type Name Description
System.String range
System.Boolean calculateHiddenRange
Returns
Type
System.String

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

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.

ComputeMin(String, Boolean)

Declaration
public string ComputeMin(string range, bool calculateHiddenRange)
Parameters
Type Name Description
System.String range
System.Boolean calculateHiddenRange
Returns
Type
System.String

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

Minute.

ComputeMInverse(String)

Declaration
public string ComputeMInverse(string arg)
Parameters
Type Name Description
System.String arg
Returns
Type
System.String

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)

Declaration
public string ComputeMmult(string arg)
Parameters
Type Name Description
System.String arg
Returns
Type
System.String

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.

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

Month.

ComputeMRound(String)

Determines the MRound value for thr Given arguments.

Declaration
public string ComputeMRound(string argsList)
Parameters
Type Name Description
System.String argsList

Number, Multiple
Returns
Type Description
System.String

MRound value of the given number

ComputeMultinomial(String)

Determines 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)

Declaration
public string ComputeMUnit(string arg)
Parameters
Type Name Description
System.String arg
Returns
Type
System.String

ComputeN(String)

Converts a value to a number.

Declaration
public string ComputeN(string args)
Parameters
Type Name Description
System.String args

Value to convert.
Returns
Type Description
System.String

Converted string.

ComputeNA()

Returns the string "#N/A" (#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 the 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.

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 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. 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. The distribution value is computed interactively using Trapezoidal Rule to six to seven significant digits or 20 iteration maximum.

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
System.String
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

Ignored.
Returns
Type Description
System.String

Current 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

ComputeOctToBin(String)

Computes the Binary value for the given Octal Number.

Declaration
public string ComputeOctToBin(string argList)
Parameters
Type Name Description
System.String argList

Data to be converted.
Returns
Type Description
System.String

Returns the calculated Binary value.

ComputeOctToDec(String)

Computes the Decimal Equivalent for the given Octal value

Declaration
public string ComputeOctToDec(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

ComputeOctToHex(String)

Calculates the Hexadecimal equivalent value for the given Octal value

Declaration
public string ComputeOctToHex(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.

ComputeOffSet(String)

Returns a range that is the offset of the reference range by rows and cols.

Declaration
public string ComputeOffSet(string arg)
Parameters
Type Name Description
System.String arg

reference, rows, cols, [height], [width]
Returns
Type Description
System.String

A range offset.
Remarks

The returned range is the range passed in through the reference variable offset by the number of rows in the rows variable and number of columns in the cols variable. If height and width are present in the argument list, they determine the number of rows and columns in the returned range. Otherwise, the dimensions of the returned range match the input range.

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

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)

Declaration
public string ComputePercentileInc(string range)
Parameters
Type Name Description
System.String range
Returns
Type
System.String

ComputePercentrank(String)

Returns the percentage rank in the range.

Declaration
public string ComputePercentrank(string range)
Parameters
Type Name Description
System.String range

Range, x, signifcant digits.
Returns
Type Description
System.String

Percentile position.
Remarks

Signifcant digits are optional, defaulting to 3.

ComputePercentrankExc(String)

Declaration
public string ComputePercentrankExc(string range)
Parameters
Type Name Description
System.String range
Returns
Type
System.String

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

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)

Declaration
public string ComputePoissonODist(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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.

ComputeProduct(String, Boolean)

Declaration
public string ComputeProduct(string range, bool calculateHiddenRange)
Parameters
Type Name Description
System.String range
System.Boolean calculateHiddenRange
Returns
Type
System.String

ComputeProper(String)

Declaration
public string ComputeProper(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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

Range, q.
Returns
Type Description
System.String

Percentile position.
Remarks

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

ComputeQuartileOExc(String)

Declaration
public string ComputeQuartileOExc(string range)
Parameters
Type Name Description
System.String range
Returns
Type
System.String

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)

Declaration
public string ComputeQuotient(string argsList)
Parameters
Type Name Description
System.String argsList
Returns
Type
System.String

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

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.

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

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)

Declaration
public string ComputeReal(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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

ComputeRept(String)

Declaration
public string ComputeRept(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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

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)

Declaration
public string ComputeRoman(string argsList)
Parameters
Type Name Description
System.String argsList
Returns
Type
System.String

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)

Declaration
public string ComputeRows(string arg)
Parameters
Type Name Description
System.String arg
Returns
Type
System.String

ComputeROWS(String)

Declaration
public string ComputeROWS(string arg)
Parameters
Type Name Description
System.String arg
Returns
Type
System.String

ComputeRRI(String)

Declaration
public string ComputeRRI(string args)
Parameters
Type Name Description
System.String args
Returns
Type
System.String

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.

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)

Declaration
public string ComputeSecant(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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

Second.

ComputeSHEET(String)

Declaration
public string ComputeSHEET(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeSHEETS(String)

Declaration
public string ComputeSHEETS(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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

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

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

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)

Declaration
public string ComputeSqrtpi(string args)
Parameters
Type Name Description
System.String args
Returns
Type
System.String

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.

ComputeStdev(String, Boolean)

Declaration
public string ComputeStdev(string range, bool calculateHiddenRange)
Parameters
Type Name Description
System.String range
System.Boolean calculateHiddenRange
Returns
Type
System.String

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.

ComputeStdevp(String, Boolean)

Declaration
public string ComputeStdevp(string range, bool calculateHiddenRange)
Parameters
Type Name Description
System.String range
System.Boolean calculateHiddenRange
Returns
Type
System.String

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.

ComputeSubTotal(String)

Returns the subtotal of input range(s).

Declaration
public string ComputeSubTotal(string args)
Parameters
Type Name Description
System.String args

A list of cell references(seperated by commas) with Number to Indicate the function
Returns
Type Description
System.String

A string holding result of the Specified Function. (i.e)Subtotal of range(s)

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.

ComputeSum(String, Boolean)

Declaration
public string ComputeSum(string range, bool calculateHiddenRange)
Parameters
Type Name Description
System.String range
System.Boolean calculateHiddenRange
Returns
Type
System.String

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)

Computes the Sum of Range1 If the item in range2 satisfies condition in range3 and item in range4 satisfies Condition in range5 etc..

Declaration
public string ComputeSumIfS(string range)
Parameters
Type Name Description
System.String range

Contains Sumrange,Criteriarange1,Criteria1 etc..
Returns
Type Description
System.String

The Conditional Sum of Range

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)

Declaration
public string ComputeT(string args)
Parameters
Type Name Description
System.String args
Returns
Type
System.String

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

Ignored.
Returns
Type Description
System.String

Current date as date serial number.

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)

Returns the vertical range of cells as a horizontal range, or vice versa

Declaration
public string ComputeTranspose(string arg)
Parameters
Type Name Description
System.String arg

Cell refrences
Returns
Type Description
System.String

value

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)

Declaration
public string ComputeTruncate(string argList)
Parameters
Type Name Description
System.String argList
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)

Declaration
public string ComputeUniChar(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ComputeUniCode(String)

Declaration
public string ComputeUniCode(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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

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.

ComputeVar(String, Boolean)

Declaration
public string ComputeVar(string range, bool calculateHiddenRange)
Parameters
Type Name Description
System.String range
System.Boolean calculateHiddenRange
Returns
Type
System.String

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.

ComputeVarp(String, Boolean)

Declaration
public string ComputeVarp(string range, bool calculateHiddenRange)
Parameters
Type Name Description
System.String range
System.Boolean calculateHiddenRange
Returns
Type
System.String

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)

Return the XML content of the given document

Declaration
public string ComputeWebService(string argList)
Parameters
Type Name Description
System.String argList

web link
Returns
Type Description
System.String

XML data

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)

Declaration
public string ComputeWeeknum(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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 the Weibull distribution.

ComputeWeiBullODist(String)

Declaration
public string ComputeWeiBullODist(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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)

Declaration
public string ComputeWorkDayintl(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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.

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

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.

CreateSheetFamilyID()

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

Declaration
public static int CreateSheetFamilyID()
Returns
Type Description
System.Int32

Sheet family id.
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.

Delta(String)

Compares the given two values

Declaration
public string Delta(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

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides

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

Gestep(String)

Compares the given two values

Declaration
public string Gestep(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

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)

Declaration
public DataTable GetDataFromArgs(string args)
Parameters
Type Name Description
System.String args
Returns
Type
System.Data.DataTable

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 calculateHiddenRange)
Parameters
Type Name Description
System.String arg

A parsed formula, raw number, or cell reference.
System.Boolean calculateHiddenRange
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.

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.

GetVisibility(String)

Returns the visibility of the range from the Model.

Declaration
public bool GetVisibility(string range)
Parameters
Type Name Description
System.String range
Returns
Type Description
System.Boolean

If the range is visible returns True otherwise returns False

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

ImConjugate(String)

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

Declaration
public string ImConjugate(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.

IMCSC(String)

Declaration
public string IMCSC(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

IMLOG10(String)

Returns the LOG10 value of the given Complex Number.

Declaration
public string IMLOG10(string argList)
Parameters
Type Name Description
System.String argList

Input Complex Number
Returns
Type Description
System.String

The Log10 of the given Complex Number.

IMLOG2(String)

Declaration
public string IMLOG2(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

ImProduct(String)

Computes the Product of the given Complex Numbers

Declaration
public string ImProduct(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.

IMSEC(String)

Declaration
public string IMSEC(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

IMSecH(String)

Declaration
public string IMSecH(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

IMTan(String)

Declaration
public string IMTan(string argList)
Parameters
Type Name Description
System.String argList
Returns
Type
System.String

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
Returns
Type
System.Double

j1(String)

Declaration
public static double j1(string x)
Parameters
Type Name Description
System.String x
Returns
Type
System.Double

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

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. Weigth on the last element in array is 1.0, the 2nd to last element d, 3rd to last d^2, ...
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.

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.Model[3,4].Text = "= Sum(expenses!B2:expenses!B8)";

	//Sum the range B2:B4 from the income grid.
	this.gridControl1.Model[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.

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.

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.

ResetTokenCount()

Reset the sheet token count.

Declaration
public static void ResetTokenCount()
Remarks

While registering the grid as sheet in GridFormulaEngine, each time the TokenCount incremented. So you can use this method reset the TokenCount to 0.

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).

SplitArgsPreservingQuotedCommas(String)

Returns an array of argument strings from a single string where the arguments are delimited by .

Declaration
public string[] SplitArgsPreservingQuotedCommas(string args)
Parameters
Type Name Description
System.String args

Contains the argument list.
Returns
Type Description
System.String[]

A string array of arguments.
Remarks

This method properly preserves any quoted strings that contain the character.

StandardNormalCumulativeDistribution(Double)

Declaration
public double StandardNormalCumulativeDistribution(double x)
Parameters
Type Name Description
System.Double x
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

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

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)

Declaration
public string TranslateText(string input, string languagePair)
Parameters
Type Name Description
System.String input
System.String languagePair
Returns
Type
System.String

UniProbDens(Double, Double, Double)

Declaration
public static double UniProbDens(double x, double min, double max)
Parameters
Type Name Description
System.Double x
System.Double min
System.Double max
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.

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
Returns
Type
System.Double

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
Returns
Type
System.Double

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.

QueryDependentCellValue

Declaration
public event GridQueryDependentCellValueEventHandler QueryDependentCellValue
Event Type
Type
GridQueryDependentCellValueEventHandler

Implements

System.IDisposable