[]
        
(Showing Draft Content)

GrapeCity.Documents.Excel.AsyncCustomFunction

Class AsyncCustomFunction

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

Represents the base type for async custom function.

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

Constructors

AsyncCustomFunction(string, FunctionValueType, Parameter[])

Initializes an instance of a custom function.

protected AsyncCustomFunction(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.

AsyncCustomFunction(string, FunctionValueType)

Initializes an instance of a custom function.

protected AsyncCustomFunction(string name, FunctionValueType result)

Parameters

name string

The name of the custom function.

result FunctionValueType

Specifies the return type for the custom function.

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

Initializes an instance of a custom function.

protected AsyncCustomFunction(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.

Methods

Evaluate(object[], ICalcContext)

Calculate the function.

public override sealed 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.

EvaluateAsync(object[], ICalcContext)

Calculate the function asynchronously.

protected abstract Task<object> EvaluateAsync(object[] arguments, ICalcContext context)

Parameters

arguments object[]

The value collection of the arguments

context ICalcContext

The context of the calculation.

Returns

System.Threading.Tasks.Task<TResult><object>

The result of the function.