com.aspose.cells

com.aspose.cells

Interface ICustomFunction

  • public interface ICustomFunction

Allows users to add their custom formula calculation functions to extend the calculation engine.
User should not modify any part in the Workbook directly in this implementation. Otherwise unexpected result or Exception may be caused.

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

    • Method Detail

      • calculateCustomFunction

        public abstract java.lang.Object calculateCustomFunction(java.lang.String functionName, java.util.ArrayList paramsList, java.util.ArrayList contextObjects)
        Calculates the result of custom function. 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.

        If a custom function name is not supported, please return a null reference.
        Parameters:
        functionName - InnerCustom function name, such as "MyFunc1".
        paramsList - A list of parameters value for custom functions.
        contextObjects - A list of context objects.
        Returns:
        Result of custom function.