Skip to content

README.MD

Latest commit

 

History

History
136 lines (97 loc) · 4.38 KB

README.MD

File metadata and controls

136 lines (97 loc) · 4.38 KB

Range Basics: Get Methods

Range is the foundational object within Office Script's Excel object model. Range APIs allows access to both data and format that available on the grid and links other key objects within Excel such as worksheets, tables, charts, etc.

Range is identified using its address such as "A1:B4" or using a named-item, which is a named key for a given set of cells. In Excel object model, both a cell and group of cells are referred as range. Range can contain cell level attributes such as data within a cell and also cell and cells-level attributes such as format, borders, etc. Range can also be obtained via. users selection, which consists of at least one cell. As you interact with range, it is important to keep these cell and range relationship clear.

The following are core set of getter, setter and other useful methods most often used in scripts. This is a great starting point to begin the API jorney. The following sections divides the methods into easy to understand grouping and helps to build an easy mental model as you begin to unlock the range object's APIs.

Videos link

Range basics

Watch step by step video

Add row at the end of worksheet

Watch step by step video

Scripts

Office Script link

A collection of snippets showin in the video (doesn't do anything meaningful..)

Range 2-dimensional nature

See this page to understand range values, formuals, etc. 2D nature

Methods that return some range metadata

  • getAddress(), getAddressLocal()
  • getCellCount()
  • getRowCount(), getColumnCount()

Methods that returns data/constants associated with a given range

Returned as singular cell value

  • getFormula(), getFormulaLocal()
  • getFormulaR1C1()
  • getNumberFormat(), getNumberFormatLocal()
  • getText()
  • getValue()
  • getValueType()

Returned as 2-D arrays (whole range)

  • getFormulas(), getFormulasLocal()
  • getFormulasR1C1()
  • getNumberFormatCategories()
  • getNumberFormats(), getNumberFormatsLocal()
  • getTexts()
  • getValues()
  • getValueTypes()
  • getHidden()
  • getIsEntireRow()
  • getIsEntireColumn()

Methods that return other range object

  • getSurroundingRegion() --similar to CurrentRegion in VBA
  • getCell(row, column)
  • getColumn(column)
  • getColumnHidden()
  • getColumnsAfter(count)
  • getColumnsBefore(count)
  • getEntireColumn()
  • getEntireRow()
  • getLastCell()
  • getLastColumn()
  • getLastRow()
  • getRow(row)
  • getRowHidden()
  • getRowsAbove(count)
  • getRowsBelow(count)

--- Important/interesting---

  • workbook.getSelectedRange()
  • workbook.getActiveCell()
  • getUsedRange(valuesOnly)
  • getAbsoluteResizedRange(numRows, numColumns)
  • getOffsetRange(rowOffset, columnOffset)
  • getResizedRange(deltaRows, deltaColumns)

Methods that return a range object in relation to another range object

  • getBoundingRect(anotherRange)
  • getIntersection(anotherRange)

Methods that return other objects (non range objects)

  • getDirectPrecedents()
  • getWorksheet()
  • getTables(fullyContained)
  • getPivotTables(fullyContained)
  • getDataValidation()
  • getPredefinedCellStyle()

Set methods

Singular cell set methods

  • setFormula(formula)
  • setFormulaLocal(formulaLocal)
  • setFormulaR1C1(formulaR1C1)
  • setNumberFormatLocal(numberFormatLocal)
  • setValue(value)

2D / entire range set methods

  • setFormulas(formulas)
  • setFormulasLocal(formulasLocal)
  • setFormulasR1C1(formulasR1C1)
  • setNumberFormat(numberFormat)
  • setNumberFormats(numberFormats)
  • setNumberFormatsLocal(numberFormatsLocal)
  • setValues(values)

Other methods

  • merge(across)
  • unmerge()

Coming soon

  • Range edge APIs