Package ortus.boxlang.spreadsheet.components

Class Spreadsheet

java.lang.Object

ortus.boxlang.runtime.components.Component

ortus.boxlang.spreadsheet.components.Spreadsheet

@BoxComponent(name="Spreadsheet",
              allowsBody=false,
              requiresBody=false,
              description="Work with Excel spreadsheet files")
public class Spreadsheet
extends ortus.boxlang.runtime.components.Component

The Spreadsheet component provides functionality to work with Excel spreadsheet files. It supports multiple actions for reading, writing, and manipulating spreadsheet data. Supported actions: - read: Read a spreadsheet file into a variable - write: Write a spreadsheet object to a file - update: Update an existing spreadsheet file - create: Create a new spreadsheet object - delete: Delete a sheet from a spreadsheet - addColumn: Add a column of data to a spreadsheet - addRow: Add a row of data to a spreadsheet - addRows: Add multiple rows to a spreadsheet - deleteColumn: Delete a column from a spreadsheet - deleteRow: Delete a row from a spreadsheet - formatCell: Format a specific cell - formatColumn: Format a column - formatRow: Format a row - formatCells: Format a range of cells - mergeCells: Merge a range of cells - setActiveSheet: Set the active sheet - setCellValue: Set the value of a cell - setCellFormula: Set a formula in a cell - info: Get information about a spreadsheet

Nested Class Summary

Nested classes/interfaces inherited from class ortus.boxlang.runtime.components.Component

ortus.boxlang.runtime.components.Component.BodyResult, ortus.boxlang.runtime.components.Component.ComponentBody

Field Summary

Fields inherited from class ortus.boxlang.runtime.components.Component

componentService, declaredAttributes, DEFAULT_RETURN, functionService, interceptorService, logger, name, runtime

Constructor Summary

Constructors

Constructor	Description
Spreadsheet()	Constructor

Method Summary

Modifier and Type	Method	Description
ortus.boxlang.runtime.components.Component.BodyResult	_invoke(ortus.boxlang.runtime.context.IBoxContext context, ortus.boxlang.runtime.types.IStruct attributes, ortus.boxlang.runtime.components.Component.ComponentBody body, ortus.boxlang.runtime.types.IStruct executionState)	Main component execution method

Methods inherited from class ortus.boxlang.runtime.components.Component

announce, getDeclaredAttributes, getName, invoke, processBody, processBody, setName, validateAttributes

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 ortus.boxlang.runtime.components.Component.BodyResult _invoke(ortus.boxlang.runtime.context.IBoxContext context,
 ortus.boxlang.runtime.types.IStruct attributes,
 ortus.boxlang.runtime.components.Component.ComponentBody body,
 ortus.boxlang.runtime.types.IStruct executionState)

Main component execution method

Specified by:

_invoke in class ortus.boxlang.runtime.components.Component

Parameters:

context - The execution context

attributes - The component attributes

body - The component body

executionState - The execution state

Returns:

BodyResult indicating component execution status