com.grapecity.documents.excel

Class CustomFunction

java.lang.Object

com.grapecity.documents.excel.CustomFunction

public abstract class CustomFunction
extends java.lang.Object

Represents the base type for custom function.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
CustomFunction(java.lang.String name, FunctionValueType result) Initializes an instance of a custom function.
CustomFunction(java.lang.String name, FunctionValueType result, Parameter[] parameters) Initializes an instance of a custom function.
CustomFunction(java.lang.String name, java.lang.String description, FunctionValueType result, Parameter[] parameters) Initializes an instance of a custom function.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	evaluate(java.lang.Object[] arguments, ICalcContext context) Calculate the function.
boolean	getIsVolatile() Gets whether to allow custom formula use cache.
int	getMaxParameterCount()
FuncParameter	GetParameter(int index)
void	setIsVolatile(boolean aVolatile) Sets whether to allow custom formula use cache.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

public java.lang.String name

Constructor Detail

CustomFunction

public CustomFunction(java.lang.String name,
                      FunctionValueType result)

Initializes an instance of a custom function.

Parameters:

name - The name of the custom function.

result - Specifies the return type for the custom function.

CustomFunction

public CustomFunction(java.lang.String name,
                      FunctionValueType result,
                      Parameter[] parameters)

Initializes an instance of a custom function.

Parameters:

name - The name of the custom function.

result - Specifies the return type for the custom function.

parameters - Specifies the parmeters for the custom function.

CustomFunction

public CustomFunction(java.lang.String name,
                      java.lang.String description,
                      FunctionValueType result,
                      Parameter[] parameters)

Initializes an instance of a custom function.

Parameters:

name - The name of the custom function.

description - The description of the custom function.

result - Specifies the return type for the custom function.

parameters - Specifies the parmeters for the custom function.

Method Detail

getIsVolatile

public boolean getIsVolatile()

Gets whether to allow custom formula use cache.

setIsVolatile

public void setIsVolatile(boolean aVolatile)

Sets whether to allow custom formula use cache.

getMaxParameterCount

public int getMaxParameterCount()

GetParameter

public FuncParameter GetParameter(int index)

evaluate

public abstract java.lang.Object evaluate(java.lang.Object[] arguments,
                                          ICalcContext context)

Calculate the function.

Parameters:

arguments - the value collection of the arguments

context - the context of the calculation.

Returns:

the result of the function.