Direct calculation of custom function without writing it in a worksheet

Direct calculation of custom function without writing it in a worksheet

Please see the following sample code that illustrates the usage of this method. We have used a custom function named MyCompany.CustomFunction() and we calculate its value as “Aspose.Cells.” by ourselves and then this value is automatically concatenated with the value of cell A1 which is “Welcome to " by the calculation engine and the final calculated value returns as “Welcome to Aspose.Cells.”. As you can see in a code that we have not written our custom function anywhere in a worksheet and it is calculated directly by our own custom logic.

// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-Java
public class CustomEngine extends AbstractCalculationEngine
{
// Override the Calculate method with custom logic
public void calculate(CalculationData data)
{
// Check the forumla name and calculate it yourself
if (data.getFunctionName().equals("MyCompany.CustomFunction"))
{
// This is our calculated value
data.setCalculatedValue("Aspose.Cells.");
}
}
}
public static void main(String[] args) throws Exception {
// Create a workbook
Workbook wb = new Workbook();
// Accesss first worksheet
Worksheet ws = wb.getWorksheets().get(0);
// Add some text in cell A1
ws.getCells().get("A1").putValue("Welcome to ");
// Create a calculation options with custom engine
CalculationOptions opts = new CalculationOptions();
opts.setCustomEngine(new CustomEngine());
// This line shows how you can call your own custom function without
// a need to write it in any worksheet cell
// After the execution of this line, it will return
// Welcome to Aspose.Cells.
Object ret = ws.calculateFormula("=A1 & MyCompany.CustomFunction()", opts);
// Print the calculated value on Console
System.out.println("Calculated Value: " + ret.toString());
}

Console Output

Below is the console output of the above sample code.

 Calculated Value: Welcome to Aspose.Cells.

Related Article