Package ortus.boxlang.spreadsheet.bifs

Class Spreadsheet

java.lang.Object
ortus.boxlang.runtime.bifs.BIF
ortus.boxlang.spreadsheet.bifs.Spreadsheet
@BoxBIF(description="Work with spreadsheet files") public class Spreadsheet extends ortus.boxlang.runtime.bifs.BIF

  • Field Summary

    Fields inherited from class ortus.boxlang.runtime.bifs.BIF

    __functionName, __isMemberExecution, asyncService, cacheService, componentService, declaredArguments, functionService, interceptorService, logger, moduleService, runtime, schedulerService

  • Constructor Summary

    Constructors
    Constructor
    Description
    Spreadsheet()
    Constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    _invoke(ortus.boxlang.runtime.context.IBoxContext context, ortus.boxlang.runtime.scopes.ArgumentsScope arguments)
    Get a fluent SpreadsheetFile object that can be used to read or write properties to a loaded spreadsheet file or a new one.

    Methods inherited from class ortus.boxlang.runtime.bifs.BIF

    announce, getDeclaredArguments, invoke

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Spreadsheet

      public Spreadsheet()
      Constructor

  • Method Details

    • _invoke

      public Object _invoke(ortus.boxlang.runtime.context.IBoxContext context, ortus.boxlang.runtime.scopes.ArgumentsScope arguments)
      Get a fluent SpreadsheetFile object that can be used to read or write properties to a loaded spreadsheet file or a new one. If the path is not specified, it will return a blank spreadsheet file object you can use to write properties to a new file. If the path is specified and valid, it will load the spreadsheet file from that path. If the path is specified but not valid, it will set the path for a new file to be created later.
      Specified by:
      _invoke in class ortus.boxlang.runtime.bifs.BIF
      Parameters:
      context - The context in which the BIF is being invoked.
      arguments - Argument scope for the BIF.
      Returns:
      A fluent SpreadsheetFile object that can be used to read or write properties.