Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Interface ICustomFunction


public interface ICustomFunction

Allows users to add their custom formula calculation functions to extend the calculation engine.


Method Summary
 java.lang.Object calculateCustomFunction(java.lang.String functionName, java.util.ArrayList paramsList, java.util.ArrayList contextObjects)
          Calculates the result of custom function.
 

Method Detail

calculateCustomFunction

java.lang.Object calculateCustomFunction(java.lang.String functionName,
                                         java.util.ArrayList paramsList,
                                         java.util.ArrayList contextObjects)
Calculates the result of custom function. If a custom function name is not supported, please return a null reference. Currently there are 3 fixed context objects and some varialbe context objects:

1. Current Workbook object.

2. Current Worksheet object.

3. Current Cell object.

Others are custom function parameters text.

Parameters:
functionName - Custom function name, such as "MyFunc1".
paramsList - A list of parameters value for custom functions. The parameter object type is in the following types : Boolean,String,Integer,Double,Calendar,double[][],Double[][].
contextObjects - A list of context objects.
Returns:
Result of custom function. Only support return object types: Boolean,String,Integer,Double,Calendar,double[][],Double[][].