Class CalcEngine

CalcEngine 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

CalcEngine

Implements

System.IDisposable

Namespace: Syncfusion.Calculate

Assembly: Syncfusion.Calculate.Base.dll

Syntax

public class CalcEngine : Object, IDisposable

Constructors

CalcEngine(ICalcData)

The constructor.

Declaration

public CalcEngine(ICalcData ParentObject)

Parameters

Type	Name	Description
ICalcData	ParentObject	The ICalcData from the underlying grid.

Fields

ACC

Used to store the number

Declaration

public double ACC

Field Value

Type
System.Double

already_registered

Used to store the registed values

Declaration

public int already_registered

Field Value

Type
System.Int32

BIGNI

Used to store the value as double

Declaration

public double BIGNI

Field Value

Type
System.Double

BIGNO

Used to store the big number as double

Declaration

public double BIGNO

Field Value

Type
System.Double

FormulaErrorStrings

The list of error strings which are used within the Essential Calculate internally. Users can make changes to this internal error strings. Default settings by assigning the new strings to the corresponding position.ReloadErrorStrings should be invoked to reset or modify the internal error strings.

Declaration

public string[] FormulaErrorStrings

Field Value

Type
System.String[]

IgnoreValueChanged

Field that turns on/off processing of the ICalcData.ValueChanged event.

Declaration

public bool IgnoreValueChanged

Field Value

Type
System.Boolean

machineepsilon

Used to store the value as double

Declaration

public const double machineepsilon = 5E-16

Field Value

Type
System.Double

maxrealnumber

Used to store the value as double

Declaration

public const double maxrealnumber = 1E+300

Field Value

Type
System.Double

minrealnumber

Used to store the value as double

Declaration

public const double minrealnumber = 1E-300

Field Value

Type
System.Double

Treat1900AsLeapYear

Set the boolean as true

Declaration

public static bool Treat1900AsLeapYear

Field Value

Type
System.Boolean

Properties

ActiveCell

Gets the cell that is being calculated by the Engine.

Declaration

public string ActiveCell { get; }

Property Value

Type
System.String

Remarks

You can use this properly within your custom functions to identify the item in the ICalcData object being computed.

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.

AlwaysComputeDuringRefresh

Gets or sets whether FormulaInfo.calcID is tested before computing a formula during a call to Refresh(String)

Declaration

public bool AlwaysComputeDuringRefresh { get; set; }

Property Value

Type
System.Boolean

Remarks

When a value changes, then the Refresh method is called on any other formula that had a dependency on the changed value. During the Refresh call, the default behavior is to recompute all formulas (AlwaysComputeDuringRefresh = true). If you are using UpdateCalcID() to strictly control when new values should be used, then you should set this property to false. For example, if you are only using PullUpdatedValue(Int32, Int32, Int32) exclusively to retrieve computed values, then setting AlwaysComputeDuringRefresh = false may be more efficient as it will only recompute the value once during the calculations.

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.

CheckDanglingStack

Gets or sets whether Invalid Formula is returned when the calculation stack is not fully exhausted during a calculation.

Declaration

public bool CheckDanglingStack { get; set; }

Property Value

Type
System.Boolean

Remarks

If you enter a formula like "=(1+2)(9+8)", Essential Calculate will compute this formula as 17, ignoring the dangling 3 value on its calculation stack. If you want this situation flagged as a Invalid Formula, set this CheckDanglingStack property to true. The default value is false for backward compatibility purposes.

ColumnMaxCount

Used with row ranges to possibly provide the upperlimit on the number of columns in the ICalcData object.

Declaration

public int ColumnMaxCount { get; set; }

Property Value

Type
System.Int32

Remarks

Essential Calculate supports column ranges of the form 2:4 as in =SUM(2:4) to represent all cells in rows 2, 3 and 4 from a ICalcData object. To get a value for the number of columns, the CalcEngine first checks to see if the ICalcData object supports the ISheetData interface. If this interface is supported, the column count used to determine the range is obtained through this interface. If the ICalcData object does not support ISupportColumnCount, then the value of ColumnMaxCount is used provided ColumnMaxCount > 0. If not, the fixed value 50 is used.

DependentCells

A read-only property that gets a mapping between a cell and a list of formula cells that depend on it.

Declaration

public Hashtable DependentCells { get; }

Property Value

Type
System.Collections.Hashtable

Remarks

The key is the given cell, and the value is a ArrayList 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()
{
	CalcEngine engine = ((GridFormulaCellModel)this.gridControl1.CellModels["FormulaCell"]).Engine;
	foreach(object o in engine.DependentCells.Keys)
	{
		string s1 = o as string;
		Console.Write(s1 + " affects ");
		ArrayList ht = (ArrayList) engine.DependentCells[s1];
		foreach(object o1 in ht)
		{
			string s2 = o1 as string;
			Console.Write(s2 + " ");
		}
		Console.WriteLine("");
	}
}

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

DependentFormulaCells

A read-only property that gets a mapping between a formula cell and a list of cells upon which it depends.

Declaration

public Hashtable DependentFormulaCells { get; }

Property Value

Type
System.Collections.Hashtable

Remarks

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

Examples

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

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

	Public Sub DisplayAllFormulaDependencies()
		Dim engine As GridCalcEngine = CType(Me.gridControl1.CellModels("FormulaCell"), GridFormulaCellModel).Engine

		Dim o As Object
		For Each o In  engine.DependentFormulaCells.Keys
			Dim s1 As String = CStr(o)
			Console.Write((s1 + " depends upon "))
			Dim ht As Hashtable = CType(engine.DependentFormulaCells(s1), Hashtable)
			Dim o1 As Object
			For Each o1 In  ht.Keys
				Dim s2 As String = CStr(o1)
				Console.Write((s2 + " "))
			Next o1
			Console.WriteLine("")
		Next o
	End Sub 'DisplayAllFormulaDependencies

EnableLookupTableCaching

Gets or sets whether lookup tables used in the VLookUp and HLookUp functions are cached.

Declaration

public LookupCachingMode EnableLookupTableCaching { get; set; }

Property Value

Type
LookupCachingMode

Remarks

Depending upon your use case, caching look up tables can greatly speed up calculations involving HLookUp and VLookUp. If you make multiple calls to these functions passing in the same look up tables, and if these look up tables are relatively static (don't dynamically change as the look ups are taking place), then caching these tables will likely improve performance.

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

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

Declaration

public ArrayList ErrorStrings { get; set; }

Property Value

Type
System.Collections.ArrayList

ExcelLikeComputations

A property that gets or sets the calculations of the CalcEngine computations to mimic the computations of Excel.

Declaration

public bool ExcelLikeComputations { get; set; }

Property Value

Type
System.Boolean

ForceRefreshCall

Gets or sets whether Refresh(String) must be called on every cells whenever the ValueChanged is triggered. The default value is false.

Declaration

public bool ForceRefreshCall { get; set; }

Property Value

Type
System.Boolean

Remarks

When a value changes, then the Refresh method is called recursively every time the grid_ValuChanged is called. Setting this ForceRefreshCall to false will call Refresh for only those cells where the calculated value is actually modified.

FormulaCharacter

A static property that gets/sets character by which string starts with, can be treated as formula.

Declaration

public static char FormulaCharacter { get; set; }

Property Value

Type
System.Char

FormulaInfoTable

A read-only property that gets the collection of FormulaInfo objects being used by the CalcEngine.

Declaration

public Hashtable FormulaInfoTable { get; }

Property Value

Type
System.Collections.Hashtable

GetValueFromArgPreserveLeadingZeros

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

Declaration

public bool GetValueFromArgPreserveLeadingZeros { get; set; }

Property Value

Type
System.Boolean

Remarks

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

IterationMaxCount

Gets or sets the maximum number of iterative calls that can be made on a cell. ThrowCircularException will be set to true when you set IterationMaxCount to any value other than zero.

Declaration

public int IterationMaxCount { get; set; }

Property Value

Type
System.Int32

Remarks

Essential Calculate supports an iterative process to solve equations of the form x=f(x). Here you should think of x as being a cell reference like B2 for example. Setting IterationMaxCount to some value other than zero allows the engine to iteratively compute f(x) using the previous iteration's calculated value for x. The initial value is either 0 or the last saved value for a formula in that cell (if the calculation has been performed previously). The iterations continue until either the iteration count exceeds IterationMaxCount, or two successive iteration return values have a relative difference less than IterationMaxTolerance. For example, to have an initial value of 1, you can enter a formula =1 into the cell, and then enter the self referencing formula into the same cell. This will make the iterative calculations start at 1 instead of 0. ThrowCircularException must be set to true in order for the Iterative Calculation support to function For this reason, ThrowCircularException will be automatically set to true when you set a non-zero value to IterationMaxCount. The default value is 0 indicating that iterative calculation support is turned off.

IterationMaxTolerance

Gets or sets the success tolerance used by the CalcEngine's iterative calculation support.

Declaration

public double IterationMaxTolerance { get; set; }

Property Value

Type
System.Double

Remarks

LibraryComputationException

Gets any Exception raised during the computation of a library function provided RethrowLibraryComputationExceptions is set true.

Declaration

public Exception LibraryComputationException { get; }

Property Value

Type
System.Exception

Remarks

Use the ClearLibraryComputationException() method to set this property to null to indicate that there is no pending library exception within the engine.

LibraryFunctions

A read-only property that gets a collection holding the current library functions.

Declaration

public Hashtable LibraryFunctions { get; }

Property Value

Type
System.Collections.Hashtable

Remarks

This property 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. The function name should contain only letters, digits or an underscore. You should use the AddFunction(String, CalcEngine.LibraryFunction) method to add functions to this collection. Do not use the Add method inherited from Hashtable. The reason is that the hash key needs to be strictly upper case even though formula syntax is case insensitive with respect to functions names. Using the AddFunction method makes sure the hash key is properly set.

LockDependencies

Gets or sets a value indicating whether editing a cell’s value will update dependent cells.

Declaration

public bool LockDependencies { get; set; }

Property Value

Type	Description
System.Boolean	The default value is False.

Remarks

If enabled, editing a cell's value will not update dependent cells based on the edited value.

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 number of 'depends on another formula' 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.

MaxStackDepth

Gets or sets the maximum calculation stack depth.

Declaration

public static int MaxStackDepth { get; set; }

Property Value

Type
System.Int32

Remarks

The default is 50. This is the number of recursive calls that can be made during calculations.

NamedRanges

A property that gets/sets the current named ranges.

Declaration

public Hashtable NamedRanges { get; set; }

Property Value

Type
System.Collections.Hashtable

ParseArgumentSeparator

A static property that gets/sets character to be recognized by the parsing code as the delimiter for arguments in a named formula's argument list

Declaration

public static char ParseArgumentSeparator { get; set; }

Property Value

Type
System.Char

ParseDateTimeSeparator

A static property that gets/sets the character to be recognized by the parsing engine as decimal separator for date.

Declaration

public static char ParseDateTimeSeparator { get; set; }

Property Value

Type
System.Char

ParseDecimalSeparator

A static property that gets/sets the character to be recognized by the parsing engine as decimal separator for numbers.

Declaration

public static char ParseDecimalSeparator { get; set; }

Property Value

Type
System.Char

ReservedWordOperators

Gets or sets a string array that hold the reserved strings that will be used for the OR, AND, XOR, IF, THEN, ELSE and NOT logical operators.

Declaration

public string[] ReservedWordOperators { get; set; }

Property Value

Type
System.String[]

Examples

Here is the code that you can use to define this string array. This code shows the default strings that are used. Note that the string must include a leading and trailing blank, and must be lower case. In formulas that use these operators, the formulas themselves are case agnostic.

engine.ReservedWordOperators = new string[]
{
	" or ",     //0
    " and ",    //1
    " xor ",    //2
    " if ",     //3
    " then ",   //4
    " else ",   //5
    " not "     //6
};

RethrowLibraryComputationExceptions

Gets / sets whether the engine Rethrows any exception raised during the computation of a library function.

Declaration

public bool RethrowLibraryComputationExceptions { get; set; }

Property Value

Type
System.Boolean

Remarks

The default value is false.

RethrowParseExceptions

Gets / sets whether the engine throws an exception when parsing fails with an unknown function error.

Declaration

public bool RethrowParseExceptions { get; set; }

Property Value

Type
System.Boolean

RowMaxCount

Used with column ranges to possibly provide the upperlimit on the number of rows in the ICalcData object.

Declaration

public int RowMaxCount { get; set; }

Property Value

Type
System.Int32

Remarks

Essential Calculate supports column ranges of the form A:D as in =SUM(A:D) to represent all cells in columns A, B, C and D from a ICalcData object. To get a value for the number of rows, the CalcEngine first checks to see if the ICalcData object supports the ISheetData interface. If this interface is supported, the row count used to determine the range is obtained through this interface. If the ICalcData object does not support ISupportRowCount, then the value of RowMaxCount is used provided RowMaxCount > 0. If not, the fixed value 50 is used.

SupportLogicalOperators

Gets or sets whether OR, AND, XOR and IF THEN ELSE logical operators are supported.

Declaration

public bool SupportLogicalOperators { get; set; }

Property Value

Type
System.Boolean

Remarks

The default value is false for backward compatibility.

SupportRangeOperands

Gets or sets whether ranges can be used as binary operands.

Declaration

public bool SupportRangeOperands { get; set; }

Property Value

Type
System.Boolean

Remarks

If this property is true, Essential Calculate recognizes ranges such as B1:B5 and A4:E4 as operands of binary operators. So, if you set the formula = A1:A5 + B1:B5 into cell C4, the calculation will retrieve the values in A4 and B4 to be used in place of the corresponding ranges A1:A5 and B1:B5. Note that such ranges must either have one column wide or one row tall. This fact is used to make the corresponding lookup determined by where the host cell that holds the formula is located. This host cell must either be in the same row or column as some cell in range.

The default value is false.

SupportsSheetRanges

Gets or sets whether sheet range notation is supported.

Declaration

public bool SupportsSheetRanges { get; set; }

Property Value

Type
System.Boolean

Remarks

Excel supports sheet range notation such as = SUM( sheet1:sheet3!A1 ) + Sum( sheet1:sheet3!B1:B4 ). For backward compatibility with earlier versions that did not support this sheet range notation, you can set this SupportsSheetRanges false.

This implementation replaces a sheet range (sheet1:sheet3!B1:B4) with list of ranges (sheet1!B1:B4,sheet2!B1:B4,sheet3!B1:B4).

ThrowCircularException

Gets / sets whether the CalcQuick should throw an exception when a circular calculation is encountered.

Declaration

public bool ThrowCircularException { get; set; }

Property Value

Type
System.Boolean

Remarks

If this property is True, the CalcQuick will throw an exception when it detects a circular calculation. If ThrowCircularException is False, then no exception is thrown and the calculation will loop recursively until Engine.MaximumRecursiveCalls is exceeded.

TreatStringsAsZero

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

Declaration

public bool TreatStringsAsZero { get; set; }

Property Value

Type
System.Boolean

Remarks

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

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

UseDependencies

A property that gets / sets whether the CalcEngine should track dependencies.

Declaration

public bool UseDependencies { get; set; }

Property Value

Type
System.Boolean

Remarks

If you are using the CalEngine in a manner where you always call PullUpdatedValue to access the computations, then setting UseDependencies to False will make things more efficient as any requested computed value will be fully computed every time it is retrieved. In this situation, the CalcEngine does not need to track dependencies.

UseFormulaValues

A property that gets/sets whether Formula returns its FormulaValue instead of repeated calculation

Declaration

public bool UseFormulaValues { get; set; }

Property Value

Type
System.Boolean

Remarks

Use this property to return the FormulaValue when a cell contain more depency cells.

UseNoAmpersandQuotes

A property that gets/sets whether strings concatenated using the '&' operator should be returned inside double quote marks.

Declaration

public bool UseNoAmpersandQuotes { get; set; }

Property Value

Type
System.Boolean

ValidPrecedingChars

For internal use.

Declaration

public string ValidPrecedingChars { get; set; }

Property Value

Type
System.String

WeekEndType

Gets the weekend type

Declaration

public ArrayList WeekEndType { get; }

Property Value

Type
System.Collections.ArrayList

Methods

add_FormulaParsing(FormulaParsingEventHandler)

Declaration

public void add_FormulaParsing(FormulaParsingEventHandler value)

Parameters

Type	Name	Description
FormulaParsingEventHandler	value

add_UnknownFunction(UnknownFunctionEventHandler)

Declaration

public void add_UnknownFunction(UnknownFunctionEventHandler value)

Parameters

Type	Name	Description
UnknownFunctionEventHandler	value

AddFunction(String, CalcEngine.LibraryFunction)

A method that adds a function to the function library.

Declaration

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

Parameters

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

Returns

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

Remarks

LibraryFunction is a delegate that defines the signature of functions that you can add to the function library.

public delegate string LibraryFunction(string args);

AddNamedRange(String, String)

Adds a named range to the NamedRanges collection.

Declaration

public bool AddNamedRange(string name, string range)

Parameters

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

Returns

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

Remarks

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

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.

BaseToBase(String, Int32, Int32)

Calculates the Output to the concerned base.

Declaration

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

Parameters

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

Returns

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

besseli0(Double)

Return the value of besseli0

Declaration

public static double besseli0(double x)

Parameters

Type	Name	Description
System.Double	x	value

Returns

Type
System.Double

besseli1(Double)

Return the value of besseli1

Declaration

public static double besseli1(double x)

Parameters

Type	Name	Description
System.Double	x	value

Returns

Type
System.Double

besselk0(Double)

Return the value of besselk0

Declaration

public static double besselk0(double x)

Parameters

Type	Name	Description
System.Double	x	value

Returns

Type
System.Double

besselk1(Double)

Return the value of the besselk1

Declaration

public static double besselk1(double x)

Parameters

Type	Name	Description
System.Double	x	value

Returns

Type
System.Double

BetaCumulativeDist(Double, Double, Double)

Returns the Beta cumulative density function.

Declaration

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

Parameters

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

Returns

Type
System.Double

ChiSquaredProbabilityDensityFunction(Double, Int32)

Chi-squared probability density function.

Declaration

public double ChiSquaredProbabilityDensityFunction(double x, int k)

Parameters

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

Returns

Type
System.Double

ClearLibraryComputationException()

Call this method to clear whether an exception was raised during the computation of a library function.

Declaration

public void ClearLibraryComputationException()

ColIndex(String)

A method that gets the column index from a cell reference passed in.

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.

ComputeACCRINT(String)

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

Declaration

public string ComputeACCRINT(string args)

Parameters

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

Returns

Type	Description
System.String	Accrued interest

ComputeACCRINTM(String)

Calculates the accrued interest of a security that pays interest at maturity.

Declaration

public string ComputeACCRINTM(string args)

Parameters

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

Returns

Type	Description
System.String	Accrued interest

ComputeAcos(String)

Computes angle whose cosine is the argument.

Declaration

public string ComputeAcos(string args)

Parameters

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

Returns

Type	Description
System.String	A string holding an 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	Result of ACosh(value).

ComputeAcot(String)

Returns the arccotangent of a number.

Declaration

public string ComputeAcot(string argList)

Parameters

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

Returns

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

ComputeAcoth(String)

Returns the hyperbolic arccotangent of a number.

Declaration

public string ComputeAcoth(string argList)

Parameters

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

Returns

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

ComputeAcsch(String)

Returns the archyperbolic cosecant of an angle.

Declaration

public string ComputeAcsch(string argList)

Parameters

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

Returns

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

ComputeAddress(String)

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

Declaration

public string ComputeAddress(string argList)

Parameters

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

Returns

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

ComputeAnd(String)

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

Declaration

public string ComputeAnd(string range)

Parameters

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

Returns

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

ComputeArabic(String)

Returns the Arabic value of Raman numeric

Declaration

public string ComputeArabic(string arg)

Parameters

Type	Name	Description
System.String	arg

Returns

Type
System.String

ComputeAreas(String)

Returns the area of the passed in cell reference range

Declaration

public string ComputeAreas(string arg)

Parameters

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

Returns

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

ComputeArrayToText(String)

This function returns text from any specified array/range. It passes text values of array unchanged, and converts non-text values to text.

Declaration

public string ComputeArrayToText(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "array, format" `array`The array to return as text. `format`The format of the returned data.[optional]

Returns

Type	Description
System.String	Text from the specified array/range.

ComputeAsc(String)

Used to compute the value

Declaration

public string ComputeAsc(string arg)

Parameters

Type	Name	Description
System.String	arg	arguments

Returns

Type
System.String

ComputeAsech(String)

Returns the archyperbolic secant of an angle.

Declaration

public string ComputeAsech(string argList)

Parameters

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

Returns

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

ComputeAsin(String)

Computes angle whose sine is the argument.

Declaration

public string ComputeAsin(string args)

Parameters

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

Returns

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

ComputeAsinh(String)

The inverse of Sinh.

Declaration

public string ComputeAsinh(string args)

Parameters

Type	Name	Description
System.String	args	The given value.

Returns

Type	Description
System.String	Result of 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	Result of ATanh(value).

ComputeAvedev(String)

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

Declaration

public string ComputeAvedev(string range)

Parameters

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

Returns

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

ComputeAveragea(String)

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

Declaration

public string ComputeAveragea(string range)

Parameters

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

Returns

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

ComputeAverageIF(String)

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

Declaration

public string ComputeAverageIF(string argList)

Parameters

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

Returns

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

ComputeAverageIFS(String)

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

Declaration

public string ComputeAverageIFS(string argList)

Parameters

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

Returns

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

ComputeAvg(String)

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

Declaration

public string ComputeAvg(string range)

Parameters

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

Returns

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

ComputeBahtText(String)

Returns the row index of the passed in cell reference.

Declaration

public string ComputeBahtText(string arg)

Parameters

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

Returns

Type	Description
System.String	The row index.

Remarks

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

ComputeBase(String)

Retuns the number into text for the given radix base

Declaration

public string ComputeBase(string argList)

Parameters

Type	Name	Description
System.String	argList

Returns

Type
System.String

ComputeBesselI(String)

Return the value of the ComputeBesselI

Declaration

public string ComputeBesselI(string argList)

Parameters

Type	Name	Description
System.String	argList	arguments

Returns

Type
System.String

ComputeBesselJ(String)

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

Declaration

public string ComputeBesselJ(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Number

Returns

Type	Description
System.String	The BesselJ of the Number.

ComputebesselK(String)

Returns the value of ComputebesselK

Declaration

public string ComputebesselK(string argList)

Parameters

Type	Name	Description
System.String	argList	arguments list

Returns

Type
System.String

ComputeBesselY(String)

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

Declaration

public string ComputeBesselY(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Number

Returns

Type	Description
System.String	The BesselY of the Number.

ComputeBetaDist(String)

Returns the beta distribution.

Declaration

public string ComputeBetaDist(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the beta distribution.

ComputeBigMul(String)

Returns the full product of two 32-bit numbers.

Declaration

public string ComputeBigMul(string argList)

Parameters

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

Returns

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

ComputeBin2Dec(String)

Computes the Decimal Number for the given binary NUmber.

Declaration

public string ComputeBin2Dec(string argList)

Parameters

Type	Name	Description
System.String	argList	Input BinaryNumber

Returns

Type	Description
System.String	The resultant Decimal Number

ComputeBin2Hex(String)

Declaration

public string ComputeBin2Hex(string argList)

Parameters

Type	Name	Description
System.String	argList

Returns

Type
System.String

ComputeBin2Oct(String)

Computes the Octal Number for the given binary NUmber.

Declaration

public string ComputeBin2Oct(string argList)

Parameters

Type	Name	Description
System.String	argList	Input BinaryNumber

Returns

Type	Description
System.String	The resultant Octal Number

ComputeBinomdist(String)

Returns the binomial distribution.

Declaration

public string ComputeBinomdist(string argList)

Parameters

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

Returns

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

ComputeBitAnd(String)

Computes the Bit AND of the given two numbers.

Declaration

public string ComputeBitAnd(string argList)

Parameters

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

Returns

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

ComputeBitLShift(String)

Computes the Bit Left Shift of the given number.

Declaration

public string ComputeBitLShift(string argList)

Parameters

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

Returns

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

ComputeBitOr(String)

Computes the Bit OR of the given two numbers.

Declaration

public string ComputeBitOr(string argList)

Parameters

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

Returns

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

ComputeBitRShift(String)

Computes the Bit Right Shift of the given number.

Declaration

public string ComputeBitRShift(string argList)

Parameters

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

Returns

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

ComputeBitXor(String)

Computes the Bit XoR of the given two numbers.

Declaration

public string ComputeBitXor(string argList)

Parameters

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

Returns

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

ComputeCeiling(String)

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

Declaration

public string ComputeCeiling(string args)

Parameters

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

Returns

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

ComputeCeilingMath(String)

Returns the RoundUp of the given number to the given significance

Declaration

public string ComputeCeilingMath(string args)

Parameters

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

Returns

Type	Description
System.String	RoundUp number

ComputeCeilingPrecise(String)

Computes and returns a number that is rounded up to the nearest integer or to the nearest multiple of significance.

Declaration

public string ComputeCeilingPrecise(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "number, significance". `number`: The value to be rounded. `significance`: [optional] The multiple to which the number is to be rounded. The default value is 1.

Returns

Type	Description
System.String	A number that is rounded up to the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded up. However, if the number or the significance is zero, zero is returned.

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

ComputeChar(String)

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

Declaration

public string ComputeChar(string arg)

Parameters

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

Returns

Type	Description
System.String	The character string.

ComputeChidist(String)

Returns the chi-squared distribution.

Declaration

public string ComputeChidist(string argList)

Parameters

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

Returns

Type	Description
System.String	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	The inverse of the chi-squared distribution.

ComputeChisqOdist(String)

Returns the chi-squared distribution.

Declaration

public string ComputeChisqOdist(string argList)

Parameters

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

Returns

Type	Description
System.String	The chi-squared distribution.

ComputeChisqOdistORt(String)

Returns the chi-squared distribution.

Declaration

public string ComputeChisqOdistORt(string argList)

Parameters

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

Returns

Type	Description
System.String	The chi-squared distribution.

ComputeChisqOinv(String)

Returns the inverse of the chi-squared distribution.

Declaration

public string ComputeChisqOinv(string argList)

Parameters

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

Returns

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

ComputeChisqOinvORt(String)

Returns the inverse of the chi-squared distribution.

Declaration

public string ComputeChisqOinvORt(string argList)

Parameters

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

Returns

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

ComputeChisqOTest(String)

Returns the Chi Test for independence.

Declaration

public string ComputeChisqOTest(string range)

Parameters

Type	Name	Description
System.String	range	Actual_range, expected_range.

Returns

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

ComputeChitest(String)

Returns the Chi Test for independence.

Declaration

public string ComputeChitest(string range)

Parameters

Type	Name	Description
System.String	range	Actual_range, expected_range.

Returns

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

ComputeChoose(String)

Returns the value at the specified index from a list of values.

Declaration

public string ComputeChoose(string arg)

Parameters

Type	Name	Description
System.String	arg	A string of the form "Index, Value1, Value2,..." in which the term 'Index' denotes the index of the value to be retrieved.

Returns

Type	Description
System.String	The selected value.

ComputeChooseCols(String)

Returns specified columns from an array or range.

Declaration

public string ComputeChooseCols(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the array or range and the column indexes separated by commas. The format should be: array, col_num1, [col_num2], ... `array`: The source array or range. `col_num1`: An integer specifying the first column to return. `[col_num2]`: [optional] Index numbers of additional columns to return.

Returns

Type	Description
System.String	A formatted string representing the specified columns from the array or range.

ComputeChooseRows(String)

Returns specified rows from an array or range.

Declaration

public string ComputeChooseRows(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the array or range and the row indexes separated by commas. The format should be: array, row_num1, [row_num2], ... `array`: The source array or range. `row_num1`: An integer specifying the first row to return. `[row_num2]`: [optional] Index numbers of additional rows to return.

Returns

Type	Description
System.String	A formatted string representing the specified rows from the array or range.

ComputeClean(String)

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

Declaration

public string ComputeClean(string arg)

Parameters

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

Returns

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

ComputeCode(String)

Return the numeric code for first char of text

Declaration

public string ComputeCode(string argList)

Parameters

Type	Name	Description
System.String	argList	text

Returns

Type	Description
System.String	numeric code

ComputeColumn(String)

Returns the column index of the passed in cell reference.

Declaration

public string ComputeColumn(string arg)

Parameters

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

Returns

Type	Description
System.String	The column index.

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)

Returns the value of ComputeCombinA

Declaration

public string ComputeCombinA(string argList)

Parameters

Type	Name	Description
System.String	argList	arguments

Returns

Type
System.String

ComputeComplex(String)

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

Declaration

public string ComputeComplex(string argList)

Parameters

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

Returns

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

ComputeConcat(String)

The CONCAT function combines the text from multiple ranges and/or strings, but it doesn't provide the delimiter or IgnoreEmpty arguments.

Declaration

public string ComputeConcat(string range)

Parameters

Type	Name	Description
System.String	range	Text item to be joined. A string, or array of strings, such as a range of cells.

Returns

Type	Description
System.String	A single 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)

Return the value of ComputeConfidenceT

Declaration

public string ComputeConfidenceT(string argList)

Parameters

Type	Name	Description
System.String	argList	arguments

Returns

Type
System.String

ComputeConversion(String)

Returns the value of ComputeConversion

Declaration

public string ComputeConversion(string argList)

Parameters

Type	Name	Description
System.String	argList	arguments list

Returns

Type
System.String

ComputeCorrel(String)

Returns the correlation coefficient of 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 to evaluate to a number.

Declaration

public string ComputeCount(string range)

Parameters

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

Returns

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

ComputeCounta(String)

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

Declaration

public string ComputeCounta(string range)

Parameters

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

Returns

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

ComputeCountblank(String)

Returns the count of blank cells listed in the argument.

Declaration

public string ComputeCountblank(string range)

Parameters

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

Returns

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

ComputeCountif(String)

Counts the cells specified by some criteria.

Declaration

public string ComputeCountif(string argList)

Parameters

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

Returns

Type	Description
System.String	Number of cells meeting the criteria.

ComputeCOUNTIFS(String)

The COUNTIFS function applies criteria to cells across multiple ranges and counts the number of times all criteria are met.

Declaration

public string ComputeCOUNTIFS(string argList)

Parameters

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

Returns

Type	Description
System.String	Number of cells meeting the criteria

ComputeCoupDayBS(String)

This function computes the number of days from the beginning of the coupon period to the settlement date for a bond.

Declaration

public string ComputeCoupDayBS(string args)

Parameters

Type	Name	Description
System.String	args	A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. `settlement_date`: The date when the bond is purchased (format: DATE function or serial number). `maturity_date`: The date when the bond matures (format: DATE function or serial number). `frequency`: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). `basis`: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360).

Returns

Type	Description
System.String	A string representing the number of days from the beginning of the coupon period to the settlement date. If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned.

ComputeCoupDays(String)

This function calculates the total number of days in the coupon period that contains the settlement date for a bond.

Declaration

public string ComputeCoupDays(string args)

Parameters

Type	Name	Description
System.String	args	A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. `settlement_date`: The date when the bond is purchased (format: DATE function or serial number). `maturity_date`: The date when the bond matures (format: DATE function or serial number). `frequency`: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). `basis`: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360).

Returns

Type	Description
System.String	A string representing the total number of days in the coupon period that contains the settlement date. If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned.

ComputeCoupDaySNC(String)

This function computes the number of days from the settlement date to the next coupon date for a bond.

Declaration

public string ComputeCoupDaySNC(string args)

Parameters

Type	Name	Description
System.String	args	A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. `settlement_date`: The date when the bond is purchased (format: DATE function or serial number). `maturity_date`: The date when the bond matures (format: DATE function or serial number). `frequency`: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). `basis`: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360).

Returns

Type	Description
System.String	A string representing the number of days from the settlement date to the next coupon date. If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned.

ComputeCoupNCD(String)

This function computes the next coupon date after the settlement date for a bond and returns the date as a serial date number.

Declaration

public string ComputeCoupNCD(string args)

Parameters

Type	Name	Description
System.String	args	A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. `settlement_date`: The date when the bond is purchased (format: DATE function or serial number). `maturity_date`: The date when the bond matures (format: DATE function or serial number). `frequency`: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). `basis`: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360).

Returns

Type	Description
System.String	A string representing the next coupon date after the settlement date, formatted as a serial date number. If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned.

ComputeCoupNum(String)

This function calculates the number of coupons payable between the settlement date and the maturity date.

Declaration

public string ComputeCoupNum(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the input arguments separated by commas. The format should be: "settlement, maturity, frequency, [basis]" `settlement`: The settlement date of the security, represented as a date string. `maturity`: The maturity date of the security, represented as a date string. `frequency`: The number of coupon payments per year (1 for annual, 2 for semi-annual, 4 for quarterly). `basis` [optional]: The day count basis to use (0 = US (NASD) 30/360, 1 = Actual/actual, 2 = Actual/360, 3 = Actual/365, 4 = European 30/360). If omitted, the default is 0.

Returns

Type	Description
System.String	A string representing the number of coupons payable between the settlement date and maturity date, rounded up to the nearest whole coupon. Returns an error message if the input arguments are invalid or if an error occurs during the calculation.

ComputeCoupPCD(String)

This function computes the previous coupon date before the settlement date for a bond and returns the date as a serial date number.

Declaration

public string ComputeCoupPCD(string args)

Parameters

Type	Name	Description
System.String	args	A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. `settlement_date`: The date when the bond is purchased (format: DATE function or serial number). `maturity_date`: The date when the bond matures (format: DATE function or serial number). `frequency`: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). `basis`: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360).

Returns

Type	Description
System.String	A string representing the previous coupon date before the settlement date, formatted as a serial date number. If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned.

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	The 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 critical value.

ComputeCsc(String)

Returns the cosecant of an angle

Declaration

public string ComputeCsc(string argList)

Parameters

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

Returns

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

ComputeCsch(String)

Returns the hyperbolic cosecant of an angle.

Declaration

public string ComputeCsch(string argList)

Parameters

Type	Name	Description
System.String	argList

Returns

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

ComputeCUMIPMT(String)

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

Declaration

public string ComputeCUMIPMT(string args)

Parameters

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

Returns

Type	Description
System.String	Number of interest rate

ComputeCUMPRINC(String)

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

Declaration

public string ComputeCUMPRINC(string args)

Parameters

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

Returns

Type	Description
System.String	Cumulative principal value

ComputeDate(String)

Returns the number of days since 01 Jan 1900.

Declaration

public string ComputeDate(string argList)

Parameters

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

Returns

Type	Description
System.String	Number of days.

ComputeDatedIF(String)

Returns the number of days or months or years between two dates.

Declaration

public string ComputeDatedIF(string argList)

Parameters

Type	Name	Description
System.String	argList	Start date, end date and unit.

Returns

Type	Description
System.String	The number of days, months, or years between two dates.

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 of the given date.

ComputeDays(String)

Returns the number of days between two dates.

Declaration

public string ComputeDays(string argList)

Parameters

Type	Name	Description
System.String	argList	startDate, endDate

Returns

Type	Description
System.String	Returns the number of days

ComputeDays360(String)

Number of days between 2 dates using 360 day year.

Declaration

public string ComputeDays360(string argList)

Parameters

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

Returns

Type	Description
System.String	Days between the dates.

ComputeDb(String)

Computes the declining balance of an asset.

Declaration

public string ComputeDb(string argList)

Parameters

Type	Name	Description
System.String	argList	Delimited string containing the initial cost, salvage value, life of asset, period of calculation, and months in the 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, and factor.

Returns

Type	Description
System.String	Double declining balance.

ComputeDec2Bin(String)

Computes the Binary value for the given Decimal Number.

Declaration

public string ComputeDec2Bin(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the calculated Binary value.

ComputeDec2Hex(String)

Computes the Hexadecimal value for the given Decimal Number.

Declaration

public string ComputeDec2Hex(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the calculated Hexadecimal value.

ComputeDec2Oct(String)

Computes the Octal value for the given Decimal Number.

Declaration

public string ComputeDec2Oct(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the calculated Octal value.

ComputeDecimal(String)

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

Declaration

public string ComputeDecimal(string argList)

Parameters

Type	Name	Description
System.String	argList	text,base

Returns

Type	Description
System.String	Decimal number.

ComputeDegrees(String)

Converts radians into degrees.

Declaration

public string ComputeDegrees(string args)

Parameters

Type	Name	Description
System.String	args	Value in radians.

Returns

Type	Description
System.String	Degrees for the given radians.

ComputeDelta(String)

Compares the given two values

Declaration

public string ComputeDelta(string argList)

Parameters

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

Returns

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

ComputeDevsq(String)

Returns the sum of the squares of the mean deviations.

Declaration

public string ComputeDevsq(string range)

Parameters

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

Returns

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

ComputeDGet(String)

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

Declaration

public string ComputeDGet(string args)

Parameters

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

Returns

Type	Description
System.String	Received amount

ComputeDisc(String)

Returns the discount rate for a security.

Declaration

public string ComputeDisc(string args)

Parameters

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

Returns

Type	Description
System.String	Rate of Discount

ComputeDivRem(String)

Calculates the quotient of two 64-bit signed integers and also returns the remainder in an output parameter.

Declaration

public string ComputeDivRem(string argList)

Parameters

Type	Name	Description
System.String	argList

Returns

Type	Description
System.String	returns the quotient of two 64-bit signed integers.

ComputeDMax(String)

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

Declaration

public string ComputeDMax(string args)

Parameters

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

Returns

Type	Description
System.String	Received amount

ComputeDMin(String)

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

Declaration

public string ComputeDMin(string args)

Parameters

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

Returns

Type	Description
System.String	Received amount

ComputeDollar(String)

Converts a number to text using currency format.

Declaration

public string ComputeDollar(string args)

Parameters

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

Returns

Type	Description
System.String	Currency format string.

ComputeDollarDe(String)

Converts a number to text using currency format.

Declaration

public string ComputeDollarDe(string args)

Parameters

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

Returns

Type	Description
System.String	Currency format string.

ComputeDollarFr(String)

Converts a number to text using currency format.

Declaration

public string ComputeDollarFr(string args)

Parameters

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

Returns

Type	Description
System.String	Currency format string.

ComputeDProduct(String)

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

Declaration

public string ComputeDProduct(string args)

Parameters

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

Returns

Type	Description
System.String	Received amount

ComputeDrop(String)

This function removes the specified number of rows and/or columns from the start or end of an array or range.

Declaration

public string ComputeDrop(string args)

Parameters

Type	Name	Description
System.String	args

Returns

Type	Description
System.String	A formatted string representing the array after removing the specified rows and/or columns. If the inputs are invalid, an error message is returned.

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)

Evaluates a parsed formula.

Declaration

public string ComputedValue(string formula)

Parameters

Type	Name	Description
System.String	formula	A string holding a valid parsed formula.

Returns

Type	Description
System.String	The computed value of the formula.

Remarks

The string passed into this function must be previously parsed using ParseFormula.

ComputeDVar(String)

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

Declaration

public string ComputeDVar(string args)

Parameters

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

Returns

Type	Description
System.String	Received amount

ComputeDVarp(String)

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

Declaration

public string ComputeDVarp(string args)

Parameters

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

Returns

Type	Description
System.String	Received amount

ComputeEDate(String)

returns the date of given date after the specific month

Declaration

public string ComputeEDate(string argList)

Parameters

Type	Name	Description
System.String	argList	startDate, months

Returns

Type	Description
System.String	returns the date

ComputeEffect(String)

Compute the effective annual interest rate.

Declaration

public string ComputeEffect(string argList)

Parameters

Type	Name	Description
System.String	argList	the nominal annual interest rate and the number of compounding periods per year

Returns

Type	Description
System.String	The effective annual interest rate.

ComputeEncodeURL(String)

Returns the encode url of the given text

Declaration

public string ComputeEncodeURL(string argList)

Parameters

Type	Name	Description
System.String	argList	text

Returns

Type	Description
System.String	returns the EncodeURL

ComputeEOMonth(String)

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

Declaration

public string ComputeEOMonth(string argList)

Parameters

Type	Name	Description
System.String	argList	startDate, month

Returns

Type	Description
System.String	return the date.

ComputeErf(String)

Returns the error function .

Declaration

public string ComputeErf(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Number

Returns

Type	Description
System.String	The error function.

ComputeErfCPrecise(String)

Returns the Complement of error function .

Declaration

public string ComputeErfCPrecise(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Number

Returns

Type	Description
System.String	The Complement of error function.

ComputeErfPrecise(String)

Returns the error function .

Declaration

public string ComputeErfPrecise(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Number

Returns

Type	Description
System.String	The error function.

ComputeErrorType(String)

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

Declaration

public string ComputeErrorType(string args)

Parameters

Type	Name	Description
System.String	args

Returns

Type
System.String

ComputeEven(String)

Rounds up to larger in magnitude even number.

Declaration

public string ComputeEven(string args)

Parameters

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

Returns

Type	Description
System.String	Rounded even value.

ComputeExact(String)

Returns whether or not the two arguments passed in are exactly the same.

Declaration

public string ComputeExact(string range)

Parameters

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

Returns

Type	Description
System.String	True if the arguments are exactly the same ignoring formats, false other wise.

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.

ComputeExpand(String)

This function expands or pads an array to specified row and column dimensions.

Declaration

public string ComputeExpand(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "array, rows, columns, pad_with". `array`: The array to expand. `rows`: The number of rows in the expanded array. If missing, rows will not be expanded. `columns`: The number of columns in the expanded array. If missing, columns will not be expanded. `pad_with`: The value with which to pad. The default is #N/A.

Returns

Type	Description
System.String	An expanded or padded array with the specified row and column dimensions.

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	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	The given value, x.

Returns

Type	Description
System.String	Factorial of x.

ComputeFactdouble(String)

Returns the Double factorial value for given number.

Declaration

public string ComputeFactdouble(string args)

Parameters

Type	Name	Description
System.String	args	number to find FactDouble

Returns

Type	Description
System.String	FactDouble of given number.

ComputeFalse(String)

Returns the logical value False.

Declaration

public string ComputeFalse(string empty)

Parameters

Type	Name	Description
System.String	empty	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.

ComputeFilter(String)

This function is used to filter a range of data based on the criteria that you specify.

Declaration

public string ComputeFilter(string args)

Parameters

Type	Name	Description
System.String	args	The input arguments as a single string, separated by commas. The format is: array, include, [if_empty] `array`: The source range or array of values to filter. `include`: The criteria for filtering, provided as a Boolean array or a condition that results in a Boolean array (e.g., B2:B13=B2"). `if_empty` [optional]: The value to return if no entries meet the criteria. If omitted, a default error message is returned.

Returns

Type	Description
System.String	A string representing the filtered values based on the criteria, or an error message if the arguments are invalid or if an error occurs.

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

ComputeFind(String)

Finds the first occurrence of one string in another string.

Declaration

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

Remarks

The location count starts at 1. If the third argument is missing, it defaults to 1. If the first string does not appear in the second string, #VALUE! is returned. The searches are done in a case sensitive manner.

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.

ComputeFloorMath(String)

Rounds a number down to the nearest integer or to the nearest multiple of significance.

Declaration

public string ComputeFloorMath(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "number, significance, mode". `number`: The number to be rounded down. `significance`: [optional] The multiple to which you want to round. `mode`: [optional] The direction (toward or away from 0) to round negative numbers.

Returns

Type	Description
System.String	A number rounded down to the nearest integer or to the nearest multiple of significance.

ComputeFloorPrecise(String)

Computes and returns a number that is rounded down to the nearest integer or to the nearest multiple of significance.

Declaration

public string ComputeFloorPrecise(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "number, significance". `number`: The value to be rounded. `significance`: [optional] The multiple to which the number is to be rounded.

Returns

Type	Description
System.String	A number that is rounded down to the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded down. However, if the number or the significance is zero, zero is returned.

ComputeFOdist(String)

Returns the F probability distribution.

Declaration

public string ComputeFOdist(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the F probability distribution.

ComputeFOdistORt(String)

Returns the F (Fisher) probability distribution.

Declaration

public string ComputeFOdistORt(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the F probability distribution.

ComputeFOinv(String)

Returns the inverse of F distribution.

Declaration

public string ComputeFOinv(string argList)

Parameters

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

Returns

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

Remarks

P should be between 0 and 1.

ComputeFOinvORt(String)

Returns the inverse of F distribution.

Declaration

public string ComputeFOinvORt(string argList)

Parameters

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

Returns

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

Remarks

P should be between 0 and 1.

ComputeForecast(String)

Returns a forecasted value based on two sets of points using least square fit regression.

Declaration

public string ComputeForecast(string range)

Parameters

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

Returns

Type	Description
System.String	Forecasted value.

ComputeFormula(String)

A method that computes a parsed formula.

Declaration

public string ComputeFormula(string parsedFormula)

Parameters

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

Returns

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

ComputeFormulaText(String)

Return the value of ComputeFormulaText

Declaration

public string ComputeFormulaText(string argList)

Parameters

Type	Name	Description
System.String	argList	arguments

Returns

Type
System.String

ComputeFrequency(String)

This function calculates how often values occur within a range of values, and then returns a vertical array of numbers.

Declaration

public string ComputeFrequency(string args)

Parameters

Type	Name	Description
System.String	args	A string containing two arguments separated by a comma. the format should be: data_array, bins_array. `data_array`: The range or array of data values you want to count. `bins_array`: The range or array of intervals to group the data values into.

Returns

Type	Description
System.String	A formatted string with the frequency counts separated by semicolons, or an error message if the input is invalid.

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

ComputeGamma(String)

Computes the gamma function for the specified input.

Declaration

public string ComputeGamma(string args)

Parameters

Type	Name	Description
System.String	args	A string representing the input number for which the gamma function will be calculated.

Returns

Type	Description
System.String	A string representing the result of the gamma function calculation.

Remarks

The gamma function is an extension of the factorial function to real and complex numbers.

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

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.

ComputeGauss(String)

Calculates the standard normal cumulative distribution function (Gauss) for a given z-value. This function returns the probability that a value from a standard normal distribution (with a mean of 0 and a standard deviation of 1) is less than or equal to the given z-value.

Declaration

public string ComputeGauss(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: `"z"` `z`: The z-value for which you want to compute the cumulative distribution.

Returns

Type	Description
System.String	The probability that a value from a standard normal distribution is less than or equal to the given z-value.

Remarks

The Gauss function is used in statistics to determine the likelihood of a value falling within a specific range of a normal distribution. This can be particularly useful in hypothesis testing or probability estimation scenarios.

ComputeGcd(String)

Returns the largest integer that divide the given numbers without any reminders.

Declaration

public string ComputeGcd(string range)

Parameters

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

Returns

Type	Description
System.String	Returns the GCD value of given arguments

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 all values listed in the argument.

ComputeGestep(String)

Compares the given two values

Declaration

public string ComputeGestep(string argList)

Parameters

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

Returns

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

ComputeGrowth(String)

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

Declaration

public string ComputeGrowth(string range)

Parameters

Type	Name	Description
System.String	range	Y_range, x_range.

Returns

Type	Description
System.String	returns estimated value.

ComputeHarmean(String)

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

Declaration

public string ComputeHarmean(string range)

Parameters

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

Returns

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

ComputeHex2Bin(String)

Computes the Binary value for the given Hexadecimal Data.

Declaration

public string ComputeHex2Bin(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the calculated Binary value.

ComputeHex2Dec(String)

Computes the Decimal Equivalent for the given Hexadecimal value

Declaration

public string ComputeHex2Dec(string argList)

Parameters

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

Returns

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

ComputeHex2Oct(String)

Computes the Octal Equivalent for the given Hexadecimal value

Declaration

public string ComputeHex2Oct(string argList)

Parameters

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

Returns

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

ComputeHLookUp(String)

Returns a horizontal table look up value.

Declaration

public string ComputeHLookUp(string range)

Parameters

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

Returns

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

Remarks

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

ComputeHour(String)

Returns the hour of the given time.

Declaration

public string ComputeHour(string argList)

Parameters

Type	Name	Description
System.String	argList	Given time.

Returns

Type	Description
System.String	Hour of given time.

ComputeHStack(String)

This function appends arrays horizontally and in sequence to return a larger array.

Declaration

public string ComputeHStack(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "array1,[array2],..." `array1, array2, ...`: The arrays to append.

Returns

Type	Description
System.String	A single array that has as many columns as all of the source arrays combined and as many rows as the tallest of the source arrays.

ComputeHyperlink(String)

Create a shortcut for the link / path

Declaration

public string ComputeHyperlink(string argList)

Parameters

Type	Name	Description
System.String	argList	link,name

Returns

Type	Description
System.String	shortcut name

ComputeHypgeomdist(String)

Returns the hypergeometric distribution.

Declaration

public string ComputeHypgeomdist(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the gamma distribution.

ComputeHypgeomOdist(String)

Returns the hypergeometric distribution.

Declaration

public string ComputeHypgeomOdist(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the gamma distribution.

ComputeIEEERemainder(String)

Returns the remainder resulting from the division of a specified number by another specified number.

Declaration

public string ComputeIEEERemainder(string argList)

Parameters

Type	Name	Description
System.String	argList	contains a divisor and dividend

Returns

Type	Description
System.String	Returns the remainder.

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	Description
System.String	Retuns the error string

ComputeIfNA(String)

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

Declaration

public string ComputeIfNA(string range)

Parameters

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

Returns

Type	Description
System.String	Returns the computed value.

ComputeIFS(String)

The IFS function checks whether one or more conditions are met and returns a value that corresponds to the first TRUE condition. IFS can take the place of multiple nested IF statements, and is much easier to read with multiple conditions.

Declaration

public string ComputeIFS(string args)

Parameters

Type	Name	Description
System.String	args	A string holding [Something is True1, Value if True1, [Something is True2, Value if True2],…[Something is True127, Value if True127]

Returns

Type	Description
System.String	Returns a value that corresponds to the first TRUE condition

ComputeIHDIST(String)

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

Declaration

public string ComputeIHDIST(string range)

Parameters

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

Returns

Type
System.String

ComputeImABS(String)

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

Declaration

public string ComputeImABS(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeImaginary(String)

Gets the Imaginary part of the given Complex number.

Declaration

public string ComputeImaginary(string argList)

Parameters

Type	Name	Description
System.String	argList	Given complex number.

Returns

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

ComputeImaginaryDifference(String)

Computes the Difference of two complex number.

Declaration

public string ComputeImaginaryDifference(string argList)

Parameters

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

Returns

Type	Description
System.String	The difference of two complex numbers in x + yi or x + yj text format.

ComputeImArgument(String)

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

Declaration

public string ComputeImArgument(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeImConjugate(String)

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

Declaration

public string ComputeImConjugate(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeIMCos(String)

Returns the IMCos of the given Complex Number.

Declaration

public string ComputeIMCos(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeImCosH(String)

Returns the Hyperbolic Cos value of the given Complex Number.

Declaration

public string ComputeImCosH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeImCot(String)

Returns the IMCot of the given Complex Number.

Declaration

public string ComputeImCot(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeIMCotH(String)

Returns the IMCotH of the given Complex Number.

Declaration

public string ComputeIMCotH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeIMCSC(String)

Returns the IMCSC of the given Complex Number.

Declaration

public string ComputeIMCSC(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeIMCSCH(String)

Returns the IMCSCH of the given Complex Number.

Declaration

public string ComputeIMCSCH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeImDiv(String)

Computes the Division of the given Complex Numbers

Declaration

public string ComputeImDiv(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Numbers

Returns

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

ComputeImEXP(String)

Returns the Exponent of the given Complex Number.

Declaration

public string ComputeImEXP(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeIMLN(String)

Returns the LOG value of the given Complex Number.

Declaration

public string ComputeIMLN(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeIMLOG10(String)

Returns the LOG10 value of the given Complex Number.

Declaration

public string ComputeIMLOG10(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeIMLOG2(String)

Returns the Log2 of the given Complex Number.

Declaration

public string ComputeIMLOG2(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeImPower(String)

Returns the power of the given Complex Number.

Declaration

public string ComputeImPower(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeImProduct(String)

Computes the Product of the given Complex Numbers

Declaration

public string ComputeImProduct(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Numbers

Returns

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

ComputeIMSEC(String)

Returns the IMSEC of the given Complex Number.

Declaration

public string ComputeIMSEC(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeIMSecH(String)

Returns the IMSecH of the given Complex Number.

Declaration

public string ComputeIMSecH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeIMSin(String)

Returns the IMSin of the given Complex Number.

Declaration

public string ComputeIMSin(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeImSinH(String)

Returns the Hyperbolic Sine value of the given Complex Number.

Declaration

public string ComputeImSinH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeImSqrt(String)

Returns the Square Root of the given Complex Number.

Declaration

public string ComputeImSqrt(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeImSub(String)

Computes the Difference of two complex number.

Declaration

public string ComputeImSub(string argList)

Parameters

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

Returns

Type	Description
System.String	The calculated difference of the numbers

ComputeImSum(String)

Computes the sum of two complex number.

Declaration

public string ComputeImSum(string argList)

Parameters

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

Returns

Type	Description
System.String	The calculated sum of the numbers

ComputeIMTan(String)

Returns the IMTan of the given Complex Number.

Declaration

public string ComputeIMTan(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeIMTanH(String)

Returns the IMTanH of the given Complex Number.

Declaration

public string ComputeIMTanH(string argList)

Parameters

Type	Name	Description
System.String	argList	Input Complex Number

Returns

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

ComputeIndex(String)

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

Declaration

public string ComputeIndex(string arg)

Parameters

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

Returns

Type	Description
System.String	The value.

Remarks

Only the array form of this function is supported.

ComputeIndirect(String)

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

Syntax: INDIRECT(CellRefString, [IsA1Style])

Declaration

public string ComputeIndirect(string args)

Parameters

Type	Name	Description
System.String	args	Cell reference string.

Returns

Type	Description
System.String	Cell reference.

ComputeInfo(String)

Returns the current operation environment information

Declaration

public string ComputeInfo(string argList)

Parameters

Type	Name	Description
System.String	argList	Type

Returns

Type	Description
System.String	environment information

ComputeInt(String)

Returns the integer value.

Declaration

public string ComputeInt(string range)

Parameters

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

Returns

Type	Description
System.String	An integer.

ComputeIntercept(String)

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

Declaration

public string ComputeIntercept(string range)

Parameters

Type	Name	Description
System.String	range	y_range, x_range.

Returns

Type	Description
System.String	y-intercept for the given points.

ComputeIntrate(String)

Returns the interest rate for a fully invested security.

Declaration

public string ComputeIntrate(string argList)

Parameters

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

Returns

Type	Description
System.String	Rate of interest

ComputeIpmt(String)

Computes the interest payment for a period.

Declaration

public string ComputeIpmt(string argList)

Parameters

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

Returns

Type	Description
System.String	Interest payment.

ComputeIrr(String)

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

Declaration

public string ComputeIrr(string argList)

Parameters

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

Returns

Type	Description
System.String	Internal rate of return.

Remarks

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

ComputeIsBlank(String)

Determines whether the value is empty string.

Declaration

public string ComputeIsBlank(string args)

Parameters

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

Returns

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

ComputeIsErr(String)

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

Declaration

public string ComputeIsErr(string range)

Parameters

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

Returns

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

ComputeIsError(String)

Returns True is the string denotes an error.

Declaration

public string ComputeIsError(string range)

Parameters

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

Returns

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

ComputeIsEven(String)

Determines whether the value is even or not.

Declaration

public string ComputeIsEven(string args)

Parameters

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

Returns

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

ComputeIsFormula(String)

Return the value of ComputeIsFormula

Declaration

public string ComputeIsFormula(string argList)

Parameters

Type	Name	Description
System.String	argList	arguments

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.

ComputeIsoCeiling(String)

Computes and returns a number that is rounded up to the nearest integer or to the nearest multiple of significance.

Declaration

public string ComputeIsoCeiling(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "number, significance". `number`: The value to be rounded. `significance`: [optional] The multiple to which the number is to be rounded. The default value is 1.

Returns

Type	Description
System.String	A number that is rounded up to the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded up. However, if the number or the significance is zero, zero is returned. This follows the ISO 8601 standard.

ComputeIsOdd(String)

Determines whether the value is odd or not.

Declaration

public string ComputeIsOdd(string args)

Parameters

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

Returns

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

ComputeISOWeeknum(String)

Returns ISO week number of the year for a given date

Declaration

public string ComputeISOWeeknum(string argList)

Parameters

Type	Name	Description
System.String	argList	date

Returns

Type	Description
System.String	returns ISO week number

ComputeIspmt(String)

Computes the simple interest payment.

Declaration

public string ComputeIspmt(string argList)

Parameters

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

Returns

Type	Description
System.String	Simple interest payment.

ComputeIsRef(String)

Checks whether the value is a reference or not.

Declaration

public string ComputeIsRef(string args)

Parameters

Type	Name	Description
System.String	args	value or reference

Returns

Type	Description
System.String	TRUE or FALSE

ComputeIsText(String)

Determines whether the value is string or not.

Declaration

public string ComputeIsText(string args)

Parameters

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

Returns

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

ComputeJis(String)

Used to compute the JIS function

Declaration

public string ComputeJis(string arg)

Parameters

Type	Name	Description
System.String	arg	arguments

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)

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

Declaration

public string ComputeLcm(string range)

Parameters

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

Returns

Type	Description
System.String	The LCM value of given aruments

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

ComputeLinest(String)

Calculates the statistics for a straight line that explains the relationship between the independent variable and one or more dependent variables

Declaration

public string ComputeLinest(string range)

Parameters

Type	Name	Description
System.String	range	Parsed range.

Returns

Type	Description
System.String	an array describing the line. The function uses the least squares method to find the best fit for your data.

ComputeLn(String)

Computes the natural logarithm of the value in the argument.

Declaration

public string ComputeLn(string argList)

Parameters

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

Returns

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

ComputeLog(String)

Computes the natural logarithm of the value in the argument.

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 the natural logarithm of the value in the argument.

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 the base 10 logarithm of the value in the argument.

ComputeLogest(String)

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

Declaration

public string ComputeLogest(string range)

Parameters

Type	Name	Description
System.String	range	Y_range, x_range.

Returns

Type	Description
System.String	returns m parameter.

ComputeLogestb(String)

Returns the b value from the exponential curve y = b * m^x.

Declaration

public string ComputeLogestb(string range)

Parameters

Type	Name	Description
System.String	range	Y_range, x_range.

Returns

Type	Description
System.String	returns calculated b value.

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

ComputeLookUp(String)

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

Declaration

public string ComputeLookUp(string range)

Parameters

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

Returns

Type	Description
System.String	Matching value found in the table

ComputeLower(String)

Converts text to lowercase.

Declaration

public string ComputeLower(string args)

Parameters

Type	Name	Description
System.String	args	Value to convert.

Returns

Type	Description
System.String	Converted string.

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.

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; False is treated as 0.

ComputeMAXIFS(String)

The MAXIFS function returns the maximum value among cells specified by a given set of conditions or criteria.

Declaration

public string ComputeMAXIFS(string argList)

Parameters

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

Returns

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

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.

ComputeMDuration(String)

This function calculates the Modified Duration (MDuration) of a security, similar to the MDuration function in Excel. This measure indicates how sensitive the bond's price is to changes in interest rates, adjusted for the bond's yield and the frequency of its coupon payments.

Declaration

public string ComputeMDuration(string args)

Parameters

Type	Name	Description
System.String	args	A comma-separated string of arguments. The format should be: settlement_date, maturity_date, coupon_rate, yield_rate, frequency, [basis]. `settlement_date`: The date when the bond is purchased (format: DATE function or serial number). `maturity_date`: The date when the bond matures (format: DATE function or serial number). `coupon_rate`: The annual coupon rate of the bond as a decimal (e.g., 0.08 for 8%). `yield_rate`: The annual yield of the bond as a decimal (e.g., 0.09 for 9%). `frequency`: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). `basis`: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360).

Returns

Type	Description
System.String	A string representing the modified duration of the bond, rounded to a reasonable number of decimal places. If any input is invalid (e.g., incorrect date format, negative rates, or invalid frequency), an error message is returned.

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

ComputeMidB(String)

Returns a substring of the given string.

Declaration

public string ComputeMidB(string range)

Parameters

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

Returns

Type	Description
System.String	A substring.

ComputeMin(String)

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

Declaration

public string ComputeMin(string range)

Parameters

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

Returns

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

ComputeMina(String)

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

Declaration

public string ComputeMina(string range)

Parameters

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

Returns

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

Remarks

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

ComputeMINIFS(String)

The MINIFS function returns the minimum value among cells specified by a given set of conditions or criteria.

Declaration

public string ComputeMINIFS(string argList)

Parameters

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

Returns

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

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 of given time.

ComputeMInverse(String)

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

Declaration

public string ComputeMInverse(string arg)

Parameters

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

Returns

Type	Description
System.String	number of columns.

ComputeMirr(String)

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

Declaration

public string ComputeMirr(string argList)

Parameters

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

Returns

Type	Description
System.String	Modified internal rate of return.

ComputeMmult(String)

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

Declaration

public string ComputeMmult(string arg)

Parameters

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

Returns

Type	Description
System.String	number of columns.

ComputeMod(String)

Returns the remainder after dividing one number by another.

Declaration

public string ComputeMod(string range)

Parameters

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

Returns

Type	Description
System.String	The remainder.

ComputeMode(String)

Returns the most frequent value in the range.

Declaration

public string ComputeMode(string range)

Parameters

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

Returns

Type	Description
System.String	The most frequent value.

ComputeModeOMult(String)

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

Declaration

public string ComputeModeOMult(string range)

Parameters

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

Returns

Type	Description
System.String	The most frequent value.

ComputeModeOsngl(String)

Returns the most frequent value in the range.

Declaration

public string ComputeModeOsngl(string range)

Parameters

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

Returns

Type	Description
System.String	The most frequent value.

ComputeMonth(String)

Returns the month of the given date.

Declaration

public string ComputeMonth(string argList)

Parameters

Type	Name	Description
System.String	argList	given time

Returns

Type	Description
System.String	Month of given date.

ComputeMround(String)

Determines the number rounded to the given multiple.

Declaration

public string ComputeMround(string argList)

Parameters

Type	Name	Description
System.String	argList	Number, Multible both are required

Returns

Type	Description
System.String	Mround value of 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)

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

Declaration

public string ComputeMUnit(string arg)

Parameters

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

Returns

Type	Description
System.String	number of columns.

ComputeN(String)

Returns a number converted from the provided value.

Declaration

public string ComputeN(string args)

Parameters

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

Returns

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

ComputeNA()

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

Declaration

public string ComputeNA()

Returns

Type	Description
System.String	error value.

ComputeNegbinomdist(String)

Returns the negative binomial distribution.

Declaration

public string ComputeNegbinomdist(string argList)

Parameters

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

Returns

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

ComputeNetworkDays(String)

Returns the value of ComputeNetworkDays

Declaration

public string ComputeNetworkDays(string argList)

Parameters

Type	Name	Description
System.String	argList	arguments

Returns

Type
System.String

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

ComputeNominal(String)

This function computes the nominal interest rate based on the effective annual interest rate and the number of compounding periods per year.

Declaration

public string ComputeNominal(string args)

Parameters

Type	Name	Description
System.String	args	A comma-separated string containing two values. The format should be: effective_rate, npery. `effective_rate`: The effective annual interest rate as a decimal (e.g., 0.053543 for 5.3543%). `npery`: The number of compounding periods per year as an integer (e.g., 4 for quarterly compounding).

Returns

Type	Description
System.String	A string representing the nominal interest rate. If the input is invalid or cannot be parsed, an error message is returned.

Remarks

The nominal interest rate is calculated using the formula:

nominalRate = npery * (Math.Pow(1 + effectRate, 1.0 / npery) - 1)

where effectRate is the effective annual interest rate and npery is the number of compounding periods per year. The method checks that the effective annual interest rate is positive and that the number of compounding periods is at least 1. If the inputs are invalid (e.g., non-numeric values, negative rates, or invalid period counts), an appropriate error message is returned.

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

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	Standard normal cumulative distribution.

ComputeNormsInv(String)

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

Syntax: NORMSINV(p)

Declaration

public string ComputeNormsInv(string argList)

Parameters

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

Returns

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

Remarks

p should be between 0 and 1.

ComputeNot(String)

Flips the logical value represented by the argument.

Declaration

public string ComputeNot(string args)

Parameters

Type	Name	Description
System.String	args	A string holding either a single argument consisting of a cell reference, formula, or 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	Parameter Ignored.

Returns

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

ComputeNper(String)

Computes the number of periods 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 an investment.

Declaration

public string ComputeNpv(string argList)

Parameters

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

Returns

Type	Description
System.String	Net present value.

ComputeNumberValue(String)

Convert the text to number

Declaration

public string ComputeNumberValue(string argList)

Parameters

Type	Name	Description
System.String	argList	text,

Returns

Type	Description
System.String	decimal separator,group separator

ComputeOct2Bin(String)

Computes the Binary value for the given Octal Number.

Declaration

public string ComputeOct2Bin(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the calculated Binary value.

ComputeOct2Dec(String)

Computes the Decimal Equivalent for the given Octal value

Declaration

public string ComputeOct2Dec(string argList)

Parameters

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

Returns

Type	Description
System.String	The calculated value for the given

ComputeOct2Hex(String)

Calculates the Hexadecimal equivalent value for the given Octal value

Declaration

public string ComputeOct2Hex(string argList)

Parameters

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

Returns

Type	Description
System.String	The Converted Hexadecimal value.

ComputeOdd(String)

Rounds up to larger in magnitude odd number.

Declaration

public string ComputeOdd(string args)

Parameters

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

Returns

Type	Description
System.String	Rounded odd value.

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.

ComputePDuration(String)

This function computes the number of periods required for an investment to reach a specified future value based on the given interest rate and present value.

Declaration

public string ComputePDuration(string args)

Parameters

Type	Name	Description
System.String	args	A comma-separated string of arguments. The format should be: rate, present_value, future_value. `rate`: The interest rate per period as a decimal (e.g., 0.025 for 2.5%). `present_value`: The current value of the investment. `future_value`: The desired future value of the investment.

Returns

Type	Description
System.String	A string representing the number of periods required to reach the future value, rounded to two decimal places. If any input is invalid (e.g., negative values or non-numeric inputs), an error message is returned.

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)

Returns the percentile position in the range.

Declaration

public string ComputePercentileInc(string range)

Parameters

Type	Name	Description
System.String	range	Range, k.

Returns

Type	Description
System.String	Percentile position.

Remarks

K is a value between 0 and 1.

ComputePercentrank(String)

Returns the percentage rank in the range.

Declaration

public string ComputePercentrank(string range)

Parameters

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

Returns

Type	Description
System.String	Percentile position.

Remarks

Significant digits are optional, defaulting to 3.

ComputePercentrankExc(String)

Returns the percentage rank Exc in the range.

Declaration

public string ComputePercentrankExc(string range)

Parameters

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

Returns

Type	Description
System.String	Percentile position.

Remarks

Significant digits are optional, defaulting to 3.

ComputePercentrankInc(String)

Returns the percentage rank Inc in the range.

Declaration

public string ComputePercentrankInc(string range)

Parameters

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

Returns

Type	Description
System.String	Percentile position.

Remarks

Significant digits are optional, defaulting to 3.

ComputePermut(String)

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

Declaration

public string ComputePermut(string argList)

Parameters

Type	Name	Description
System.String	argList	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.

ComputePhi(String)

This function computes and returns the value of the density function for a standard normal distribution.

Declaration

public string ComputePhi(string args)

Parameters

Type	Name	Description
System.String	args	A string representing the numeric input for which PHI is to be calculated.

Returns

Type	Description
System.String	A formatted string representing the calculated PHI value. If the input is invalid, an error message is returned indicating the type of error.

ComputePI(String)

Returns the number pi.

Declaration

public string ComputePI(string args)

Parameters

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

Returns

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

ComputePmt(String)

Computes the payment for a loan.

Declaration

public string ComputePmt(string argList)

Parameters

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

Returns

Type	Description
System.String	Payment amount.

ComputePoisson(String)

Returns the Poisson distribution.

Declaration

public string ComputePoisson(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the exponential distribution.

Remarks

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

ComputePoissonODist(String)

Returns the Poisson distribution.

Declaration

public string ComputePoissonODist(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the exponential distribution.

Remarks

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

ComputePow(String)

Returns a specified number raised to the specified power.

Declaration

public string ComputePow(string args)

Parameters

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

Returns

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

ComputePpmt(String)

Computes the principal payment for a period.

Declaration

public string ComputePpmt(string argList)

Parameters

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

Returns

Type	Description
System.String	Principal payment.

ComputeProb(String)

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

Declaration

public string ComputeProb(string range)

Parameters

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

Returns

Type	Description
System.String	The probability.

ComputeProduct(String)

Returns the product of the arguments in the list.

Declaration

public string ComputeProduct(string range)

Parameters

Type	Name	Description
System.String	range	List of arguments.

Returns

Type	Description
System.String	Product of the arguments.

ComputeProper(String)

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

Declaration

public string ComputeProper(string argList)

Parameters

Type	Name	Description
System.String	argList	Text

Returns

Type	Description
System.String	proper text

ComputePv(String)

Computes the present value of an investment.

Declaration

public string ComputePv(string argList)

Parameters

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

Returns

Type	Description
System.String	Present value.

ComputeQuartile(String)

Returns the quartile position in the range.

Declaration

public string ComputeQuartile(string range)

Parameters

Type	Name	Description
System.String	range	Range, q.

Returns

Type	Description
System.String	Percentile position.

Remarks

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

ComputeQuartileOExc(String)

Returns the quartile position in the range.

Declaration

public string ComputeQuartileOExc(string range)

Parameters

Type	Name	Description
System.String	range	Range, q.

Returns

Type	Description
System.String	Percentile position.

Remarks

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

ComputeQuartileOInc(String)

Returns the quartile position in the range.

Declaration

public string ComputeQuartileOInc(string range)

Parameters

Type	Name	Description
System.String	range	Range, q.

Returns

Type	Description
System.String	Percentile position.

Remarks

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

ComputeQuotient(String)

Returns the integer portion of division function.

Declaration

public string ComputeQuotient(string range)

Parameters

Type	Name	Description
System.String	range	numerator, denominator to find the quotient

Returns

Type	Description
System.String	returns integer value.

ComputeRadians(String)

Converts degrees into radians.

Declaration

public string ComputeRadians(string args)

Parameters

Type	Name	Description
System.String	args	Value in degrees.

Returns

Type	Description
System.String	Radians for the given degrees.

ComputeRand(String)

Returns an evenly distributed random number >= 0 and < 1.

Declaration

public string ComputeRand(string args)

Parameters

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

Returns

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

ComputeRandbetween(String)

Returns a random integer number between the specified two numbers.

Declaration

public string ComputeRandbetween(string argList)

Parameters

Type	Name	Description
System.String	argList	StartNumber, EndNumber

Returns

Type	Description
System.String	Random numberbetween two value

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

ComputeRankOAvg(String)

Returns the rank of x in the range.

Declaration

public string ComputeRankOAvg(string range)

Parameters

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

Returns

Type	Description
System.String	Rank of x.

ComputeRankOEq(String)

Returns the rank of x in the range.

Declaration

public string ComputeRankOEq(string range)

Parameters

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

Returns

Type	Description
System.String	Rank of x.

ComputeRate(String)

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

Declaration

public string ComputeRate(string argList)

Parameters

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

Returns

Type	Description
System.String	Internal rate of return.

Remarks

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

ComputeReal(String)

Gets the Real part of the given Complex number.

Declaration

public string ComputeReal(string argList)

Parameters

Type	Name	Description
System.String	argList	Given complex number.

Returns

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

ComputeReceived(String)

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

Declaration

public string ComputeReceived(string args)

Parameters

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

Returns

Type	Description
System.String	Received amount

ComputeReplace(String)

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

Declaration

public string ComputeReplace(string argList)

Parameters

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

Returns

Type	Description
System.String	replaced string

ComputeReplaceB(String)

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

Declaration

public string ComputeReplaceB(string argList)

Parameters

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

Returns

Type	Description
System.String	returns replaced text

ComputeRept(String)

Returns the number of repeated text

Declaration

public string ComputeRept(string argList)

Parameters

Type	Name	Description
System.String	argList	text, repeated count

Returns

Type	Description
System.String	text

ComputeRight(String)

Returns the right so many characters in the given string.

Declaration

public string ComputeRight(string range)

Parameters

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

Returns

Type	Description
System.String	A right substring.

ComputeRightB(String)

Returns the right so many characters in the given string.

Declaration

public string ComputeRightB(string range)

Parameters

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

Returns

Type	Description
System.String	A right substring.

ComputeRoman(String)

Returns the arabic numeral to roman in TEXT format

Declaration

public string ComputeRoman(string argList)

Parameters

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

Returns

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

ComputeRound(String)

Rounds a number to a specified number of digits.

Declaration

public string ComputeRound(string argList)

Parameters

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

Returns

Type	Description
System.String	Rounded number.

ComputeRounddown(String)

Rounds a number to a specified number of digits.

Declaration

public string ComputeRounddown(string argList)

Parameters

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

Returns

Type	Description
System.String	Rounded number.

ComputeRoundup(String)

Rounds a number to a specified number of digits.

Declaration

public string ComputeRoundup(string argList)

Parameters

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

Returns

Type	Description
System.String	Rounded number.

ComputeRow(String)

Returns the row index of the passed in cell reference.

Declaration

public string ComputeRow(string arg)

Parameters

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

Returns

Type	Description
System.String	The row index.

Remarks

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

ComputeRows(String)

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

Declaration

public string ComputeRows(string arg)

Parameters

Type	Name	Description
System.String	arg	Contains one argument.

Returns

Type	Description
System.String	number of rows.

ComputeRRI(String)

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

Declaration

public string ComputeRRI(string args)

Parameters

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

Returns

Type	Description
System.String	Returns the equivalent interest.

ComputeRsq(String)

Returns the square of the Pearson product moment correlation coefficient.

Declaration

public string ComputeRsq(string range)

Parameters

Type	Name	Description
System.String	range	Range1, range2.

Returns

Type	Description
System.String	Square of the Pearson product.

ComputeSearch(String)

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

Declaration

public string ComputeSearch(string argList)

Parameters

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

Returns

Type	Description
System.String	index of the string

ComputeSearchB(String)

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

Declaration

public string ComputeSearchB(string argList)

Parameters

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

Returns

Type	Description
System.String	index of the string

ComputeSecant(String)

Returns the secant of an angle.

Declaration

public string ComputeSecant(string argList)

Parameters

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

Returns

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

ComputeSecanth(String)

Returns the hyperbolic secant of an angle.

Declaration

public string ComputeSecanth(string argList)

Parameters

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

Returns

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

ComputeSecond(String)

Returns the second of the given time.

Declaration

public string ComputeSecond(string argList)

Parameters

Type	Name	Description
System.String	argList	Given time.

Returns

Type	Description
System.String	Second of given time.

ComputeSequence(String)

This function generates a list of sequential numbers in an array.

Declaration

public string ComputeSequence(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "rows, columns, start, step". `rows`: The number of rows to fill. `columns`: The number of columns to fill. If omitted, defaults to 1 column. `start`: The starting number in the sequence. If omitted, defaults to 1. `step`: The increment for each subsequent value in the sequence. It can be positive or negative.

Returns

Type	Description
System.String	Generates and returns an array of sequential numbers.

ComputeSeriessum(String)

Return the value of ComputeSeriessum

Declaration

public string ComputeSeriessum(string arg)

Parameters

Type	Name	Description
System.String	arg	arguments

Returns

Type
System.String

ComputeSheet(String)

return the sheet number of the given value

Declaration

public string ComputeSheet(string argList)

Parameters

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

Returns

Type	Description
System.String	sheet number

ComputeSheets(String)

return the sheet number of the given values

Declaration

public string ComputeSheets(string argList)

Parameters

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

Returns

Type	Description
System.String	sheet number

ComputeSign(String)

Returns a number indicating the sign of the argument.

Declaration

public string ComputeSign(string args)

Parameters

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

Returns

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

ComputeSin(String)

Computes the sine of the argument.

Declaration

public string ComputeSin(string args)

Parameters

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

Returns

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

ComputeSinh(String)

Computes the hyperbolic sine of the argument.

Declaration

public string ComputeSinh(string args)

Parameters

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

Returns

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

ComputeSkew(String)

Returns the skewness of a distribution.

Declaration

public string ComputeSkew(string range)

Parameters

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

Returns

Type	Description
System.String	Skewness of a distribution.

ComputeSkewP(String)

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

Declaration

public string ComputeSkewP(string range)

Parameters

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

Returns

Type	Description
System.String	Skewness of a distribution.

ComputeSln(String)

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

Declaration

public string ComputeSln(string argList)

Parameters

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

Returns

Type	Description
System.String	Depreciation of the asset.

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 for the given points.

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.

ComputeSort(String)

This function sorts the contents of an array or range by columns or rows in ascending or descending order.

Declaration

public string ComputeSort(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "array, sort_index, sort_order, by_col". `array`: The array or range to be sorted. `sort_index` [Optional]: The column or row index on which to base the sorting. If omitted, the first column or row is used. `sort_order` [Optional]: Defines the sort order. If omitted, the default is ascending order. 1 or omitted - Ascending order (default). -1 - Descending order. `by_col` [Optional]: A logical value indicating the direction of sorting. If omitted, the default is to sort by rows. FALSE or omitted - Sort by row (default). TRUE - Sort by column.

Returns

Type	Description
System.String	A string representing the sorted array.

ComputeSortBy(String)

This function sorts the contents of a range or array based on the values in corresponding ranges or arrays.

Declaration

public string ComputeSortBy(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "array, by_array1, sort_order1, by_array2, sort_order2,…". `array`: The array or range to sort. `by_array1`: The array or range to sort by. `sort_order1`: The order to use for sorting. Default is ascending.

Returns

Type	Description
System.String	A sorted range or array.

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)

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

Declaration

public string ComputeSqrtpi(string args)

Parameters

Type	Name	Description
System.String	args	Number

Returns

Type	Description
System.String	Sqrtpi value of given number

ComputeStandardize(String)

Returns a normalized value.

Declaration

public string ComputeStandardize(string argList)

Parameters

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

Returns

Type	Description
System.String	Normalized value.

ComputeStdev(String)

Returns the sample standard deviation.

Declaration

public string ComputeStdev(string range)

Parameters

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

Returns

Type	Description
System.String	The sample standard deviation.

ComputeStdeva(String)

Returns the sample standard deviation.

Declaration

public string ComputeStdeva(string range)

Parameters

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

Returns

Type	Description
System.String	The sample standard deviation.

Remarks

Treats True as 1; False as 0.

ComputeStdevaP(String)

Returns the sample standard deviation.

Declaration

public string ComputeStdevaP(string range)

Parameters

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

Returns

Type	Description
System.String	The sample standard deviation.

Remarks

Treats True as 1; False as 0.

ComputeStdevaS(String)

Returns the sample standard deviation.

Declaration

public string ComputeStdevaS(string range)

Parameters

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

Returns

Type	Description
System.String	The sample standard deviation.

Remarks

Treats True as 1; False as 0.

ComputeStdevp(String)

Returns the population standard deviation.

Declaration

public string ComputeStdevp(string range)

Parameters

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

Returns

Type	Description
System.String	The population standard deviation.

ComputeStdevpa(String)

Returns the population standard deviation.

Declaration

public string ComputeStdevpa(string range)

Parameters

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

Returns

Type	Description
System.String	The population standard deviation.

Remarks

Treats True as 1; 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)

Returns

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

ComputeSumif(String)

Sums the cells specified by some criteria.

Declaration

public string ComputeSumif(string argList)

Parameters

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

Returns

Type	Description
System.String	A string holding the sum.

ComputeSumIFS(String)

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

Declaration

public string ComputeSumIFS(string argList)

Parameters

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

Returns

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

ComputeSumProduct(String)

Returns the sum of the products of corresponding values.

Declaration

public string ComputeSumProduct(string range)

Parameters

Type	Name	Description
System.String	range	Two cell ranges.

Returns

Type	Description
System.String	Sum of the products.

ComputeSumsq(String)

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

Declaration

public string ComputeSumsq(string range)

Parameters

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

Returns

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

ComputeSumx2my2(String)

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

Declaration

public string ComputeSumx2my2(string range)

Parameters

Type	Name	Description
System.String	range	x_range and y_range.

Returns

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

ComputeSumx2py2(String)

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

Declaration

public string ComputeSumx2py2(string range)

Parameters

Type	Name	Description
System.String	range	x_range and y_range.

Returns

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

ComputeSumxmy2(String)

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

Declaration

public string ComputeSumxmy2(string range)

Parameters

Type	Name	Description
System.String	range	x_range and y_range.

Returns

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

ComputeSwitch(String)

The SWITCH function evaluates an expression against a list of values and returns the result corresponding to the first matching value. If there is no match, an optional default value may be returned.

Declaration

public string ComputeSwitch(string args)

Parameters

Type	Name	Description
System.String	args	A string holding expression, value1, result1, [default or value2, result2],…[default or value3, result3]

Returns

Type	Description
System.String	Returns the result corresponding to the first matching value

ComputeSyd(String)

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

Declaration

public string ComputeSyd(string argList)

Parameters

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

Returns

Type	Description
System.String	Depreciation for the requested period.

ComputeT(String)

Returns the string or text referred by the given value.

Declaration

public string ComputeT(string args)

Parameters

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

Returns

Type	Description
System.String	Returns the referred text

ComputeTake(String)

This function retrieves a specified subset of values from a given array or range based on the number of rows and/or columns provided.

Declaration

public string ComputeTake(string args)

Parameters

Type	Name	Description
System.String	args

Returns

Type	Description
System.String	A formatted string containing the subset of values from the specified array or range. If the input is invalid, an appropriate error message is returned.

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.

ComputeTextAfter(String)

This function returns text that occurs after given character or string.

Declaration

public string ComputeTextAfter(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "text,delimiter,instance_num, match_mode, match_end, if_not_found". `text`The text you are searching within. Wildcard characters not allowed. `delimiter`The text that marks the point after which you want to extract. `instance_num`[Optional] The instance of the delimiter after which you want to extract the text.(default is 1). `match_mode`[Optional] Determines whether the text search is case-sensitive. The default is case-sensitive. `match_end`[Optional] Treats the end of text as a delimiter. By default, the text is an exact match. `if_not_found`[Optional] Value returned if no match is found. By default, #N/A is returned.

Returns

Type	Description
System.String	The text that occurs after given character or string.

ComputeTextBefore(String)

This function returns text that occurs text that occurs before a given character or string

Declaration

public string ComputeTextBefore(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "text,delimiter,instance_num, match_mode, match_end, if_not_found" `text`The text you are searching within. Wildcard characters not allowed. `delimiter`The text that marks the point after which you want to extract. `instance_num`[Optional] The instance of the delimiter after which you want to extract the text.(default is 1). `match_mode`[Optional] Determines whether the text search is case-sensitive. The default is case-sensitive. `match_end`[Optional] Treats the end of text as a delimiter. By default, the text is an exact match. `if_not_found`[Optional] Value returned if no match is found. By default, #N/A is returned.

Returns

Type	Description
System.String	The text that occurs before a given character or string.

ComputeTextJoin(String)

The TEXTJOIN function combines the text from multiple ranges and/or strings, and includes a delimiter you specify between each text value that will be combined. If the delimiter is an empty text string, this function will effectively concatenate the ranges.

Declaration

public string ComputeTextJoin(string range)

Parameters

Type	Name	Description
System.String	range	A text string, or array of strings, such as a range of cells.

Returns

Type	Description
System.String	A single string.

ComputeTextSplit(String)

This function splits text strings by using column and row delimiters.

Declaration

public string ComputeTextSplit(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "text, col_delimiter, row_delimiter, ignore_empty, match_mode, pad_with". `text`: The text you want to split. `col_delimiter`: The text that marks the point where to spill the text across columns. `row_delimiter` [optional]: The text that marks the point where to spill the text down rows. `ignore_empty` [optional]: Specifies whether to ignore empty values or not. Defaults to FALSE. `match_mode` [optional]: Determines case-sensitivity for the delimiter. Enabled by default. `pad_with` [optional]: A value to use in place of missing values in two-dimensional arrays. The default is a #N/A error.

Returns

Type	Description
System.String	Splitted text strings by using column and row delimiters.

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.

ComputeToCol(String)

Declaration

public string ComputeToCol(string args)

Parameters

Type	Name	Description
System.String	args

Returns

Type
System.String

ComputeToday(String)

Returns the current date as a date serial number.

Declaration

public string ComputeToday(string argList)

Parameters

Type	Name	Description
System.String	argList	Parameter Ignored.

Returns

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

ComputeTOdist(String)

Returns the Student's t-distribution.

Declaration

public string ComputeTOdist(string argList)

Parameters

Type	Name	Description
System.String	argList	x, degreesfreedom1.

Returns

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

ComputeTOInv(String)

Returns the Student's t-distribution.

Declaration

public string ComputeTOInv(string argList)

Parameters

Type	Name	Description
System.String	argList	x, degreesfreedom1.

Returns

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

ComputeToRow(String)

Declaration

public string ComputeToRow(string args)

Parameters

Type	Name	Description
System.String	args

Returns

Type
System.String

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

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)

Returns the value of computeTruncate

Declaration

public string ComputeTruncate(string argList)

Parameters

Type	Name	Description
System.String	argList	arguments

Returns

Type
System.String

ComputeType(String)

Returns the interger value for the datatype of given text

Declaration

public string ComputeType(string argList)

Parameters

Type	Name	Description
System.String	argList	text

Returns

Type	Description
System.String	integer value

ComputeUniChar(String)

Returns the Unicode char for the respective numeric value

Declaration

public string ComputeUniChar(string argList)

Parameters

Type	Name	Description
System.String	argList	Number

Returns

Type	Description
System.String	unicode char

ComputeUniCode(String)

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

Declaration

public string ComputeUniCode(string argList)

Parameters

Type	Name	Description
System.String	argList	text

Returns

Type	Description
System.String	numeric code

ComputeUnidist(String)

Returns the PDF of the uniform distribution.

Declaration

public string ComputeUnidist(string argList)

Parameters

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

Returns

Type	Description
System.String	The binomial distribution.

ComputeUnique(String)

Declaration

public string ComputeUnique(string args)

Parameters

Type	Name	Description
System.String	args

Returns

Type
System.String

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 in the given string.

ComputeValueToText(String)

This function returns text from any specified value. It passes text values unchanged, and converts non-text values to text.

Declaration

public string ComputeValueToText(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "value, format" `value`The value to return as text. `format`The format of the returned data.[optional]

Returns

Type	Description
System.String	Text from any specified value

ComputeVar(String)

Returns sample variance of the listed values.

Declaration

public string ComputeVar(string range)

Parameters

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

Returns

Type	Description
System.String	The sample variance.

ComputeVara(String)

Returns sample variance of the listed values.

Declaration

public string ComputeVara(string range)

Parameters

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

Returns

Type	Description
System.String	The sample variance.

Remarks

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

ComputeVarp(String)

Returns population variance of the listed values.

Declaration

public string ComputeVarp(string range)

Parameters

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

Returns

Type	Description
System.String	The population variance.

ComputeVarpa(String)

Returns population variance of the listed values.

Declaration

public string ComputeVarpa(string range)

Parameters

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

Returns

Type	Description
System.String	The population variance.

Remarks

True is treated as 1; 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.

ComputeVarS(String)

Computes the sample variance for a set of numbers.

Declaration

public string ComputeVarS(string args)

Parameters

Type	Name	Description
System.String	args	A string containing a comma-separated list of numbers for which the sample variance will be calculated.

Returns

Type	Description
System.String	A string representing the sample variance of the provided numbers.

Remarks

The sample variance is a measure of the dispersion of data points in a sample, and is calculated by taking the average of the squared deviations from the mean.

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

ComputeVStack(String)

This function appends arrays vertically and in sequence to return a larger array.

Declaration

public string ComputeVStack(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "array1,[array2],..." `array1, array2, ...`: The arrays to append.

Returns

Type	Description
System.String	A single array that has as many columns as all of the source arrays combined and as many rows as the tallest of the source arrays.

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)

Returns the week number of a specific date

Declaration

public string ComputeWeeknum(string argList)

Parameters

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

Returns

Type	Description
System.String	returns the week number

ComputeWeibull(String)

Returns the Weibull distribution.

Declaration

public string ComputeWeibull(string argList)

Parameters

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

Returns

Type	Description
System.String	The Weibull distribution.

ComputeWeiBullODist(String)

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

Declaration

public string ComputeWeiBullODist(string argList)

Parameters

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

Returns

Type	Description
System.String	Returns the calculated weibull distribution.

Remarks

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

ComputeWorkDay(String)

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

Declaration

public string ComputeWorkDay(string argList)

Parameters

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

Returns

Type	Description
System.String	returns the date

ComputeWorkDayintl(String)

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

Declaration

public string ComputeWorkDayintl(string argList)

Parameters

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

Returns

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

ComputeWrapCols(String)

This function computes the vector (one-dimensional array) and returns the wrapped values.

Declaration

public string ComputeWrapCols(string args)

Parameters

Type	Name	Description
System.String	args	The input arguments as a single string separated by commas. The format is: vector, wrap_count, [pad_with] `vector`: The source one-dimensional array or range. `wrap_count`: The maximum number of values per column. `pad_with` [optional]: The value to pad the last column with if there are insufficient items to fill it. If omitted, the missing values will be padded with #N/A (default).

Returns

Type	Description
System.String	A string representing the wrapped columns or an error message.

ComputeWrapRows(String)

This function computes the vector (one-dimensional array) and returns the wrapped values.

Declaration

public string ComputeWrapRows(string args)

Parameters

Type	Name	Description
System.String	args	The input arguments as a single string separated by commas. The format is: vector, wrap_count, [pad_with] `vector`: The source one-dimensional array or range. `wrap_count`: The maximum number of values per row. `pad_with` [optional]: The value to pad the last row with if there are insufficient items to fill it. If omitted, the missing values will be padded with #N/A (default).

Returns

Type	Description
System.String	A string representing the wrapped rows or an error message.

ComputeXirr(String)

Computes the internal rate of return for a schedule of possibly non-periodic cash flows.

Declaration

public string ComputeXirr(string argList)

Parameters

Type	Name	Description
System.String	argList	A list of two or three arguments. The first argument contains a range of cash flows, the second argument contains a list of corresponding date serial number values, and the third argument contains an initial guess at the return value.

Returns

Type	Description
System.String	The internal rate of return.

Remarks

The computation uses a root finding algorithm. If the algorithm does not converge to a result within 100 iterations, an error is returned. The convergence requirement is an absolute error of 0.000001. The first date must be the earliest date, and the dates must be date serial numbers. Also, there must be at least one positive cash flow and at least one negative cash flow in the cash flow values.

ComputeXLookUp(String)

Searches a range or an array, and then returns the item corresponding to the first match it finds.
If no match exists, then XLOOKUP can return the closest (approximate) match.

Declaration

public string ComputeXLookUp(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "lookup_value, lookup_array, return_array, if_not_found, match_mode, search_mode". `lookup_value`: The value to search for. `lookup_array`: The array or range of cells to search within. `return_array`: The array or range of cells from which to return a value. `if_not_found`: The value to return if no match is found. `match_mode`: [Optional] The match type (default is 0): `search_mode`: [Optional] The search mode (default is 1):

Returns

Type	Description
System.String	The item corresponding to the first match it finds. If no match exists, then XLOOKUP can return the closest (approximate) match.

ComputeXMatch(String)

Returns the relative position of an item in an array or range of cells.

Declaration

public string ComputeXMatch(string args)

Parameters

Type	Name	Description
System.String	args	A string containing the arguments separated by commas. The format should be: "lookup_value,lookup_array,match_mode,search_mode". `lookup_value`: The value to search for. `lookup_array`: The array or range of cells to search within, provided as a comma-separated string of values. `match_mode`: [Optional] The match type (default is 0): `search_mode`: [Optional] The search mode (default is 1):

Returns

Type	Description
System.String	The relative position of an item in an array or range of cells.

ComputeXor(String)

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

Declaration

public string ComputeXor(string range)

Parameters

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

Returns

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

ComputeYear(String)

Returns the year of the given date.

Declaration

public string ComputeYear(string argList)

Parameters

Type	Name	Description
System.String	argList	Given date.

Returns

Type	Description
System.String	Month of given date.

ComputeYearFrac(String)

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

Declaration

public string ComputeYearFrac(string argList)

Parameters

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

Returns

Type	Description
System.String	returns the fraction of the year

ComputeZOtest(String)

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

Declaration

public string ComputeZOtest(string range)

Parameters

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

Returns

Type	Description
System.String	Kth smallest value.

ComputeZtest(String)

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

Declaration

public string ComputeZtest(string range)

Parameters

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

Returns

Type	Description
System.String	Kth smallest value.

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

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

Declaration

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

Parameters

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

Returns

Type
System.Double

CreateSheetFamilyID()

CreateSheetFamilyID is a method to create familyID for a sheet.

Declaration

public static int CreateSheetFamilyID()

Returns

Type	Description
System.Int32	Sheet family ID.

Remarks

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

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Factorial(Int32)

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

Declaration

public static long Factorial(int n)

Parameters

Type	Name	Description
System.Int32	n

Returns

Type
System.Int64

getBetween(String, String, String)

Return the value of between strings

Declaration

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

Parameters

Type	Name	Description
System.String	strSource	source string
System.String	strStart	start
System.String	strEnd	end

Returns

Type
System.String

GetCalcID()

Retrieves the current CalcEngine calculation level ID.

Declaration

public int GetCalcID()

Returns

Type	Description
System.Int32	Current calculation level ID.

GetCellsFromArgs(String)

A method that retrieves a string array of cells from the range passed in.

Declaration

public string[] GetCellsFromArgs(string args)

Parameters

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

Returns

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

Remarks

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

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

A1:A5

A1:C5

GetDataFromArgs(String)

Used to get the data from arguments

Declaration

public DataTable GetDataFromArgs(string args)

Parameters

Type	Name	Description
System.String	args	Arguments

Returns

Type
System.Data.DataTable

GetFormulaArrayBounds(String, Int32, Int32, out Int32, out Int32, out Int32, out Int32)

Return the value of arraybounds as boolean

Declaration

public bool GetFormulaArrayBounds(string currentCell, int arrayHeight, int arrayWidth, out int firstRowIndex, out int firstColIndex, out int lastRowIndex, out int lastColIndex)

Parameters

Type	Name	Description
System.String	currentCell	current cell
System.Int32	arrayHeight	height
System.Int32	arrayWidth	width
System.Int32	firstRowIndex	firstrowindex
System.Int32	firstColIndex	firstcolumnindex
System.Int32	lastRowIndex	lastrowindex
System.Int32	lastColIndex	lastcolumnindex

Returns

Type
System.Boolean

GetFormulaRowCol(ICalcData, Int32, Int32)

Gets the text of any formula at the given row and column of the ICalcData object.

Declaration

public string GetFormulaRowCol(ICalcData grd, int row, int col)

Parameters

Type	Name	Description
ICalcData	grd	The ICalcData object.
System.Int32	row	The one-based row in the grd object.
System.Int32	col	The one-based col in the grd object.

Returns

Type	Description
System.String	String containing the text of the formula.

Remarks

If the data item at row and column is not a formula, the return value is an empty string.

GetSheetFamilyItem(ICalcData)

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(ICalcData model)

Parameters

Type	Name	Description
ICalcData	model	The grid model.

Returns

Type	Description
GridSheetFamilyItem	The GridSheetFamilyItem for the specified model.

GetSheetID(ICalcData)

This method used to find the sheet id of the parsed grid.

Declaration

public int GetSheetID(ICalcData grd)

Parameters

Type	Name	Description
ICalcData	grd	Intsance of ICalcData

Returns

Type	Description
System.Int32	The sheet id of the grid

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)

A Virtual method to compute the value based on the argument passed in.

Declaration

public virtual 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, a raw number, or a 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.

GetValueFromParentObject(ICalcData, Int32, Int32)

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

Declaration

public string GetValueFromParentObject(ICalcData grd, int row, int col)

Parameters

Type	Name	Description
ICalcData	grd	The ICalcData object holding the requested cell.
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.

GetValueFromParentObject(ICalcData, Int32, Int32, Boolean)

Returns the value of specified cell in a Grid.

Declaration

public string GetValueFromParentObject(ICalcData grd, int row, int col, bool calculateFormula)

Parameters

Type	Name	Description
ICalcData	grd	The ICalcData object holding the requested cell.
System.Int32	row	Row index of the requested cell.
System.Int32	col	Column index of the requested cell.
System.Boolean	calculateFormula	If true, compute the formula and returns calculated result. Else, simply returns the value of the cell

Returns

Type	Description
System.String	the value of the cell.

GetValueFromParentObject(Int32, Int32)

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

Declaration

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

GetValueFromParentObject(String)

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

Declaration

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

GetValueFromParentObject(String, Boolean)

Returns the value of specified cell in a Grid.

Declaration

public string GetValueFromParentObject(string cell1, bool calculateFormula)

Parameters

Type	Name	Description
System.String	cell1	Cell address
System.Boolean	calculateFormula	If true, compute the formula and returns calculated result. Else, simply returns the value of the cell.

Returns

Type	Description
System.String	value of the cell

HalfLifeOfGeometricSeries(Double, Int32)

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

Declaration

public static double HalfLifeOfGeometricSeries(double decayFactor, int length)

Parameters

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

Returns

Type
System.Double

HandleIteration(String, FormulaInfo)

Return the value of HandleIteration

Declaration

public string HandleIteration(string s, FormulaInfo formula)

Parameters

Type	Name	Description
System.String	s	value
FormulaInfo	formula	formula

Returns

Type
System.String

IHProbDens(Double, Int32)

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

Declaration

public static double IHProbDens(double x, int n)

Parameters

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

Returns

Type
System.Double

InitLibraryFunctions()

Creates and initially loads the function library with the supported functions.

Declaration

public virtual void InitLibraryFunctions()

InverseSumOfGeometricSeries(Double, Int32)

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

Declaration

public static double InverseSumOfGeometricSeries(double decayFactor, int length)

Parameters

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

Returns

Type
System.Double

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)

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

Declaration

public static double j1(string x)

Parameters

Type	Name	Description
System.String	x

Returns

Type
System.Double

LookupCachingClearAll()

Clears all look up caches used in HLookUp and VLookUp calculations so they will be recreated the next time one of these functions is used.

Declaration

public void LookupCachingClearAll()

LookupCachingClearSheet(ICalcData)

Returns the value of Clearsheet

Declaration

public void LookupCachingClearSheet(ICalcData grd)

Parameters

Type	Name	Description
ICalcData	grd	Icalcdata

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

Mean(Double[], Double, Int32)

Returns the mean of an array.

Declaration

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

Parameters

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

Returns

Type
System.Double

MostRecentValues(Double[], Int32)

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

Declaration

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

Parameters

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

Returns

Type
System.Double[]

ParseAndComputeFormula(String)

A method that parses and computes the string formula passed in.

Declaration

public string ParseAndComputeFormula(string formula)

Parameters

Type	Name	Description
System.String	formula	The text formula to be parsed and computed.

Returns

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

ParseFormula(String)

A method that parses the text in a formula passed in.

Declaration

public string ParseFormula(string formula)

Parameters

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

Returns

Type	Description
System.String	A string holding a parsed representation of the formula.

PlaceVariablenameTokensIntoFormula(String)

Swaps variable names for tokens.

Declaration

public string PlaceVariablenameTokensIntoFormula(string formula)

Parameters

Type	Name	Description
System.String	formula	The formula holding variable names.

Returns

Type	Description
System.String	The formula with tokens.

PullUpdatedValue(Int32, Int32, Int32)

PullUpdatedValue is a method used to recompute the cells that are referred to compute the requested value.

Declaration

public void PullUpdatedValue(int targetSheetID, int row, int col)

Parameters

Type	Name	Description
System.Int32	targetSheetID	Integer identifying the ICalcData object.
System.Int32	row	The row in the ICalcData object.
System.Int32	col	The column in the ICalcData object.

PullUpdatedValue(String)

This method retrieves the value in the requested cell reference using fresh computations for any cells that affect the value of the requested cell.

Declaration

public string PullUpdatedValue(string cellRef)

Parameters

Type	Name	Description
System.String	cellRef	A cell reference like: Sheet5!B14

Returns

Type	Description
System.String	A freshly computed value for the cell.

PutTokensForSheets(ref String)

Accepts an unparsed formula string and replaces any sheet references with corresponding tokens.

Declaration

public void PutTokensForSheets(ref string text)

Parameters

Type	Name	Description
System.String	text	The unparsed formula string.

Remarks

This is an advanced method that lets you replace sheet names with corresponding tokens. You may have need of this method if you are adding your own functions to the function library.

RecalculateRange(RangeInfo, ICalcData)

This method recalculates any formula cells in the specified range.

Declaration

public void RecalculateRange(RangeInfo range, ICalcData data)

Parameters

Type	Name	Description
RangeInfo	range	GridRangInfo object that specifies the cells to be recalculated.
ICalcData	data	ICalcData object that holds the data 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.

Refresh(String)

Refresh is a method that 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(RangeInfo)

Recalculates every cell that depends upon any cell in the passed-in range.

Declaration

public void RefreshRange(RangeInfo range)

Parameters

Type	Name	Description
RangeInfo	range	RangeInfo object to be refreshed.

Remarks

For example, if range is RangeInfo(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, ICalcData, Int32)

RegisterGridAsSheet is a method that registers an ICalcData object so it can be referenced in a formula from another ICalcData object.

Declaration

public void RegisterGridAsSheet(string refName, ICalcData model, int sheetFamilyID)

Parameters

Type	Name	Description
System.String	refName	The reference name used to refer to this ICalcData object from formulas in other ICalcData objects.
ICalcData	model	The ICalcData from the ICalcData object being registered.
System.Int32	sheetFamilyID	An integer previously created with a call to CalcEngine.CreateSheetFamilyID. This number is used to identify the ICalcData objects as belonging to a particular family of ICalcData objects. You can only reference ICalcData objects from within the same family.

Remarks

Essential Calculate supports multisheet references with its formulas. For example, if you have two ICalcData objects, then you can reference cells from the first ICalcData object in the second ICalcData object. For this to work, both ICalcData objects 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 is cell A1 for the ICalcData object whose reference name is sheet1 to the value from cell C3 in the ICalcData object whose reference name is sheet2.

Examples

Use this code to use cross sheet references:

	//Register three ICalcData objects so cell can be referenced across ICalcData objects:
	int sheetfamilyID = CalcEngine.CreateSheetFamilyID();
	myCalcEngine.RegisterGridAsSheet("summary", calcData1, sheetfamilyID);
	myCalcEngine.RegisterGridAsSheet("income", calcData2, sheetfamilyID);
	myCalcEngine.RegisterGridAsSheet("expenses", calcData3, sheetfamilyID);
	....
	//Sample formula usage for cells in calcData1, the 'summary' data source.
	//This code sums ups some cells from calcData3, the 'expenses' data source
	//and calcData2, the 'income' data source.
	//Sum the range B2:B8 from expenses:
	string sumExpenses = "= Sum(expenses!B2:expenses!B8)";
	//Sum the range B2:B4 from income:
	string sumIncome = "= Sum(income!B2:income!B4)";

	'Register three ICalcData objects so cell can be referenced across ICalcData objects:
	Dim sheetfamilyID As Integer = CalcEngine.CreateSheetFamilyID();
	myCalcEngine.RegisterGridAsSheet("summary", calcData1, sheetfamilyID)
	myCalcEngine.RegisterGridAsSheet("income", calcData2, sheetfamilyID)
	myCalcEngine.RegisterGridAsSheet("expenses", calcData3, sheetfamilyID)
	....
	'Sample formula usage for cells in calcData1, the 'summary' data source.
	'This code sums ups some cells from calcData3, the 'expenses' data source
	'and calcData2, the 'income' data source.
	'Sum the range B2:B8 from expenses:
	Dim sumExpenses As String = "= Sum(expenses!B2:expenses!B8)"
	'Sum the range B2:B4 from income:
	Dim sumIncome As String = "= Sum(income!B2:income!B4)"

RegisterVariableNames(String[])

Registers a list of variable names so you can use it within formulas.

Declaration

public void RegisterVariableNames(string[] list)

Parameters

Type	Name	Description
System.String[]	list	List of names.

ReloadErrorStrings()

Use this method to reset internal error strings if you make changes to FormulaErrorStrings.

Declaration

public void ReloadErrorStrings()

remove_FormulaParsing(FormulaParsingEventHandler)

Declaration

public void remove_FormulaParsing(FormulaParsingEventHandler value)

Parameters

Type	Name	Description
FormulaParsingEventHandler	value

remove_UnknownFunction(UnknownFunctionEventHandler)

Declaration

public void remove_UnknownFunction(UnknownFunctionEventHandler value)

Parameters

Type	Name	Description
UnknownFunctionEventHandler	value

RemoveFunction(String)

A method that 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, otherwise False.

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 if successfully removed, otherwise False.

RenameSheet(String, ICalcData)

Change the sheet name of ICalcData with the given name.

Declaration

public void RenameSheet(string sheetName, ICalcData model)

Parameters

Type	Name	Description
System.String	sheetName	Name of the sheet.
ICalcData	model	The ICalcData object.

ResetSheetFamilyID()

A method to reset the cached ICalcData object IDs.

Declaration

public static void ResetSheetFamilyID()

ResetSheetIDs()

Resets the internal sheet token marker to 0.

Declaration

public static void ResetSheetIDs()

Remarks

When RegisterGridAsSheet is called to add a ICalcData object to a CalcEngine, this newly added sheet is associated with an integer used in tokenizing formulas. This sheetID integer is required in the PullUpdatedValue method to specify the ICalcData object being accessed. The GetSheetID method allows you to retrieve a sheetID given an ICalcData object. This internal sheet token marker is a static member of CalcEngine, and is incremented each time a new ICalcData object is registered with the CalcEngine using RegisterGridAsSheet.

ResetVariableNames()

Clears any variable names registered with the CalcEngine.

Declaration

public void ResetVariableNames()

RowIndex(String)

A method to retrieve 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.

SplitArgsPreservingQuotedCommas(String)

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

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

StandardNormalCumulativeDistribution(Double)

Returns the CDF of the standard normal distribution.

Declaration

public double StandardNormalCumulativeDistribution(double x)

Parameters

Type	Name	Description
System.Double	x	Value at which the distribution is evaluated.

Returns

Type
System.Double

StandardNormalCumulativeDistributionFunction(Double)

Returns the CDF of the standard normal distribution.

Declaration

public double StandardNormalCumulativeDistributionFunction(double x)

Parameters

Type	Name	Description
System.Double	x	Value at which the distribution is evaluated.

Returns

Type
System.Double

StandardNormalCumulativeDistributionFunctionInverse(Double)

Returns the inverse of the CDF of the standard normal distribution.

Declaration

public double StandardNormalCumulativeDistributionFunctionInverse(double p)

Parameters

Type	Name	Description
System.Double	p	Cumulative probability of the distribution. p is between 0 and 1.

Returns

Type
System.Double

StandardNormalCumulativeDistributionInverse(Double)

Returns the inverse of the CDF of the standard normal distribution.

Declaration

public double StandardNormalCumulativeDistributionInverse(double p)

Parameters

Type	Name	Description
System.Double	p	Cumulative probability of the distribution. p is between 0 and 1.

Returns

Type
System.Double

StandardNormalProbabilityDensity(Double)

Returns the PDF of the standard normal distribution.

Declaration

public double StandardNormalProbabilityDensity(double x)

Parameters

Type	Name	Description
System.Double	x	Value at which the distribution is evaluated.

Returns

Type
System.Double

StripTics(String)

Removes outer quote marks from a string with no inner quote marks.

Declaration

public string StripTics(string s)

Parameters

Type	Name	Description
System.String	s	The string with possible outer quote marks.

Returns

Type	Description
System.String	The string with any outer quote marks removed.

Remarks

This is a utility method that removes outer quotes on a string.

SumOfGeometricSeries(Double, Int32)

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

Declaration

public static double SumOfGeometricSeries(double decayFactor, int length)

Parameters

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

Returns

Type
System.Double

SumOfInfiniteGeometricSeries(Double)

Returns the sum of an infinite geometric series who's first element is 1. For decay factor d, S = 1 + d + d^2 + ...

Declaration

public static double SumOfInfiniteGeometricSeries(double decayFactor)

Parameters

Type	Name	Description
System.Double	decayFactor	Decay factor. Typically between -1 adn +1.

Returns

Type
System.Double

ToString()

An overridden method to display 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.

TranslateText(String, String)

Return the value of TranslateText

Declaration

public string TranslateText(string input, string languagePair)

Parameters

Type	Name	Description
System.String	input	value
System.String	languagePair	language

Returns

Type
System.String

UniformCumulativeDensityFunction(Double, Double, Double)

Returns the CDF of the uniform distribution.

Declaration

public static double UniformCumulativeDensityFunction(double x, double min, double max)

Parameters

Type	Name	Description
System.Double	x	Value at which the distribution is evaluated.
System.Double	min	Minimum value of the distribution.
System.Double	max	Maximum value of the distribution.

Returns

Type
System.Double

UniProbDens(Double, Double, Double)

Returns the PDF of the uniform distribution.

Declaration

public static double UniProbDens(double x, double min, double max)

Parameters

Type	Name	Description
System.Double	x	Value at which the distribution is evaluated.
System.Double	min	Minimum value of the distribution.
System.Double	max	Maximum value of the distribution.

Returns

Type
System.Double

UnregisterGridAsSheet(String, ICalcData)

Unregisters a grid so it can no longer be referenced in a formula from another grid.

Declaration

public static void UnregisterGridAsSheet(string refName, ICalcData model)

Parameters

Type	Name	Description
System.String	refName	The reference name used to refer to this grid from formulas in other grids.
ICalcData	model	The grid model.

UpdateCalcID()

A method that increases the calculation level of the CalcEngine.

Declaration

public void UpdateCalcID()

Remarks

Every formula has a calculation ID level associated with it. Every time a formula is retrieved, its calculation ID level is compared with the CalcEngine ID level. If they do not agree, the formula is recomputed. Calling UpdateCalcID will force any formula to be recomputed the next time it is retrieved.

UpdateDependenciesAndCell(String)

Triggers a calculation for any value depending upon the given cell.

Declaration

public void UpdateDependenciesAndCell(string cell1)

Parameters

Type	Name	Description
System.String	cell1	The cell.

WeightedMean(Double[], Double[])

Returns the weighted averages of the values in valueArray using the corresponding weights in weightArray.

Declaration

public double WeightedMean(double[] valueArray, double[] weightArray)

Parameters

Type	Name	Description
System.Double[]	valueArray	array of values for which we are computing the weighted average
System.Double[]	weightArray	array of weights used in computing the weighted average

Returns

Type
System.Double

y0(Double)

Returns the Bessel function of the second kind, of order 0 of the specified number.

Declaration

public static double y0(double x)

Parameters

Type	Name	Description
System.Double	x

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 FormulaParsingEventHandler FormulaParsing

Event Type

Type
FormulaParsingEventHandler

Remarks

This event may be raised more than once in the processing of a string into a formula.

UnknownFunction

Occurs whenever an unknown function is encountered during the parsing of a formula.

Declaration

public event UnknownFunctionEventHandler UnknownFunction

Event Type

Type
UnknownFunctionEventHandler

Remarks

This event may be raised more than once in the parsing of a formula.

Implements

System.IDisposable