XLConnect (version 1.1.0)

getReferenceFormula-methods: Querying reference formulas of Excel names

Description

Queries the reference formula of an Excel named range in a workbook.

Usage

# S4 method for workbook
getReferenceFormula(object,name, worksheetScope)

Arguments

object

The workbook to use

name

The named range to query. This argument is vectorized such that multiple names can be queried with one method call.

worksheetScope

Optional - the name of the worksheet in which the name is scoped; if undefined a matching name in any scope may be returned. To specify global scope only, use the value ""

.

Author

Martin Studer
Mirai Solutions GmbH https://mirai-solutions.ch

Details

If option XLConnect.setCustomAttributes is TRUE (default FALSE), the worksheet scope in which the queried name is defined is set as attribute worksheetScope on the result.

See Also

workbook, createName, existsName, removeName

Examples

if (FALSE) {
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

# Load workbook
wb <- loadWorkbook(demoExcelFile)

# Query reference formula for name 'mtcars'
print(getReferenceFormula(wb, name = "mtcars"))
}