com.aspose.cells

Class CustomFunctionDefinition

java.lang.Object

com.aspose.cells.CustomFunctionDefinition

public class CustomFunctionDefinition
extends java.lang.Object

Definition of custom function for calculating with user's custom engine.

Constructor Summary

Constructors

Constructor and Description
CustomFunctionDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getArrayModeParameters(java.lang.String functionName) Gets the indices of given custom function's parameters that need to be calculated in array mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFunctionDefinition

public CustomFunctionDefinition()

Method Detail

getArrayModeParameters

public int[] getArrayModeParameters(java.lang.String functionName)

Gets the indices of given custom function's parameters that need to be calculated in array mode.

Remarks

For an expression that needs to be calculated, taking A:A+B:B as an example: Generally in value mode it will be calculated to a single value according to current cell base. But in array mode, all values of A1+B1,A2+B2,A3+B3,... will be calculated and used for the calculation.

Parameters:

functionName - Name of the custom function.

Returns:

Indices of the parameters that need to be calculated in array mode for given custom function. Default is null, there is no parameter which needs to be calculated in array mode for the custom function.