Package io.keikai.axyra.sheets.formula

Class Functions

java.lang.Object
io.keikai.axyra.sheets.formula.Functions
public final class Functions extends Object
Queries the engine's catalog of built-in Excel-compatible functions. These calls are stateless; no workbook is needed. Functions registered with Workbook.registerFunction or Workbook.registerTypedFunction are not part of the catalog. 

 if (!Functions.contains("XLOOKUP")) { ... }

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    contains(String name)
    Whether a built-in function has this name, ignoring case.
    static int
    count()
    The number of built-in functions; equal to list().length.
    static String[]
    list()
    The upper-case names of every built-in function, sorted alphabetically, without the _xlfn. prefix.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • count

      public static int count()
      The number of built-in functions; equal to list().length.

    • contains

      public static boolean contains(String name)
      Whether a built-in function has this name, ignoring case. User-defined functions are not included. The file prefix _xlfn. is not accepted: pass "XLOOKUP", not "_xlfn.XLOOKUP".
      Parameters:
      name - the function name without parentheses
      Returns:
      true if the engine evaluates this function

    • list

      public static String[] list()
      The upper-case names of every built-in function, sorted alphabetically, without the _xlfn. prefix.
      Returns:
      a new array on each call