Function Class

Represents a function in the calculation engine.

Inheritance

object

Function

Implements

IEquatable<Function>

Namespace: GrapeCity.CalcEngine

Assembly: GrapeCity.CalcEngine.dll

Syntax

public class Function : IEquatable<Function>

Public Class [Function]
    Implements IEquatable(Of Function)

Constructors

Name	Description
Function(string, int, int, FunctionAttributes)	Initializes a new instance of the Function class.

Fields

Name	Description
MaxSupportedArguments	The maximum number of arguments supported by the function.

Properties

Name	Description
Category	Gets the function category.
Hidden	Gets a boolean value indicating whether the function is hidden.
IsAttached	Gets a value indicating whether this function is attached to the workbookset.
MaxArgs	Gets the maximum argument count of the function.
MinArgs	Gets the minimum argument count of the function.
Name	Gets the function name.
Settings	Gets or sets the settings of function.

Methods

Name	Description
CalculateFormulaArrayDimensions(IArguments, out int, out int)	Update the dimensions of target dynamic evaluated array.
CanReturnDelegate()	Gets or sets a boolean value indicating whether the function can return an IDelegate object as result.
Clone()	Clones this function.
Equals(Function)	Indicates whether the current object is equal to another object of the same type.
Equals(object)	Determines whether the specified object is equal to this instance.
Evaluate(IArguments, IValue)	Evaluates the function based on specified arguments and set evaluated value to `result`.
FinishEvaluatingFormulaArray(IArguments)	Finishes evaluating multiple cells as formula array.
GetArgumentType(int, int)	Determines whether the expression at specified index is an input name.
GetFormulaArrayDimensions(IEvaluationContext, IValue, out int, out int)	Calculates the dimensions of the specified argument.
GetFunctionName(ICalcEngineLanguagePackage)	Gets the localized name of the function.
GetHashCode()	Returns a hash code for this instance.
GetMinimumArgumentCount(int)	Gets the minimum number of arguments must be passed to the function.
GetVisibilityDependent(int, int)	Determines whether the visibility change affects to the calculation.
IsArrayParameter(int)	Determines whether the expression at specified index is evaluated as an array parameter.
IsChangedBehavior(WorkbookCompatibility, WorkbookCompatibility)	Gets a boolean value indicating whether the function's evaluated result may volatiles when the workbook's compatibility is changed.
IsExplicitPrecedent(int)	Determines whether the evaluated result depends on all values from the argument.
StartEvaluatingFormulaArray(IArguments)	Starts evaluating multiple cells as formula array.