Get Started
Documentation

Api

new Api()

Methods

Name Description
AddSheet

Create a sheet.

CreateBlipFill

Create a blip fill which allows to fill the object using a selected image as the object background.

CreateBullet

Create a bullet for a paragraph with the character or symbol specified with the sBullet parameter.

CreateColorByName

Create a color selecting it from one of the available color presets.

CreateColorFromRGB

Create an RGB color setting the appropriate values for the red, green and blue color components.

CreateGradientStop

Create a gradient stop used for different types of gradients.

CreateLinearGradientFill

Create a linear gradient fill which allows to fill the object using a selected linear gradient as the object background.

CreateNoFill

Create no fill and remove the fill from the element.

CreateNumbering

Create a bullet for a paragraph with the character or symbol specified with the sType parameter.

CreateParagraph

Create a new paragraph.

CreatePatternFill

Create a pattern fill which allows to fill the object using a selected pattern as the object background.

CreatePresetColor

Create a color selecting it from one of the available color presets.

CreateRGBColor

Create an RGB color setting the appropriate values for the red, green and blue color components.

CreateRun

Create a new smaller text block to be inserted to the current paragraph or table.

CreateSchemeColor

Create a complex color scheme selecting from one of the available schemes.

CreateSolidFill

Create a solid fill which allows to fill the object using a selected solid color as the object background.

CreateStroke

Create a stroke adding shadows to the element.

Format

Returns a class formatted according to instructions contained in a format expression

GetActiveSheet

Get the object that represents the active sheet.

GetLocale

Returns current locale id.

GetSheet

Returns an object that represents the sheet

GetSheets

Returns a Sheets collection that represents all the sheets in the active workbook.

GetThemesColors

Get the list of all available theme colors for the spreadsheet.

SetLocale

Set locale for document.

SetThemeColors

Set the theme colors to the current spreadsheet.