com.aspose.cells.ICustomFunction.html Maven / Gradle / Ivy

Go to download






ICustomFunction





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.
            
            NOTE: This member is now obsolete. Instead, 
            please use AbstractCalculationEngine which provides more convenient and flexible APIs
            for manipulating custom functions.
            This interface will be removed 12 months later since August 2020. 
            Aspose apologizes for any inconvenience you may have experienced.












Method Summary




abstract 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 
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.




See Also:


          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.

          Aspose.Cells Support Forum - our preferred method of support.
We guarantee a prompt response to any inquiry!
© 2003-2022 Aspose Pty Ltd. All rights reserved.

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

calculateCustomFunction
public abstract java.lang.Object calculateCustomFunction(java.lang.String functionName, java.util.ArrayList paramsList, java.util.ArrayList contextObjects)

com.aspose.cells.ICustomFunction.html Maven / Gradle / Ivy

com.aspose.cells Interface ICustomFunction

calculateCustomFunction

com.aspose.cells
Interface ICustomFunction