Package ortus.boxlang.spreadsheet.bifs

Class SpreadsheetGetCellComment

java.lang.Object
ortus.boxlang.runtime.bifs.BIF
ortus.boxlang.spreadsheet.bifs.SpreadsheetGetCellComment
@BoxBIF(description="Gets all or a single comment from a cell in a spreadsheet.") public class SpreadsheetGetCellComment 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
    SpreadsheetGetCellComment()
    Constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    _invoke(ortus.boxlang.runtime.context.IBoxContext context, ortus.boxlang.runtime.scopes.ArgumentsScope arguments)
    Gets the comment from a cell in a spreadsheet or all comments if row/column not provided.

    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

    • SpreadsheetGetCellComment

      public SpreadsheetGetCellComment()
      Constructor

  • Method Details

    • _invoke

      public Object _invoke(ortus.boxlang.runtime.context.IBoxContext context, ortus.boxlang.runtime.scopes.ArgumentsScope arguments)
      Gets the comment from a cell in a spreadsheet or all comments if row/column not provided.
      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:
      If row and column are provided: A struct with {Author, Column, Comment, Row}, or null if no comment exists. If row and column are NOT provided: An array of structs with all comments in the sheet.