[]
        
(Showing Draft Content)

GrapeCity.Documents.Excel.CustomFunction

Class CustomFunction

Namespace
GrapeCity.Documents.Excel
Assembly
GcDocs.Excel.dll

Represents the base type for custom function.

public abstract class CustomFunction
Inheritance
object
CustomFunction
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()

Constructors

CustomFunction(string, FunctionValueType, Parameter[])

Initializes an instance of a custom function.

public CustomFunction(string name, FunctionValueType result, Parameter[] parameters)

Parameters

name string

The name of the custom function.

result FunctionValueType

Specifies the return type for the custom function.

parameters Parameter[]

Specifies the parmeters for the custom function.

CustomFunction(string, FunctionValueType)

Initializes an instance of a custom function.

public CustomFunction(string name, FunctionValueType result)

Parameters

name string

The name of the custom function.

result FunctionValueType

Specifies the return type for the custom function.

CustomFunction(string, string, FunctionValueType, Parameter[])

Initializes an instance of a custom function.

public CustomFunction(string name, string description, FunctionValueType result, Parameter[] parameters)

Parameters

name string

The name of the custom function.

description string

The description of the custom function.

result FunctionValueType

Specifies the return type for the custom function.

parameters Parameter[]

Specifies the parmeters for the custom function.

Properties

IsVolatile

Gets or sets whether to allow custom formula use cache.

public bool IsVolatile { get; set; }

Property Value

bool

Methods

Evaluate(object[], ICalcContext)

Calculate the function.

public abstract object Evaluate(object[] arguments, ICalcContext context)

Parameters

arguments object[]

the value collection of the arguments

context ICalcContext

the context of the calculation.

Returns

object

the result of the function.