getReferenceFormula-methods: Querying reference formulas of Excel names

In XLConnect: Excel Connector for R

Querying reference formulas of Excel names

Description

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

Usage

## S4 method for signature '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 ""

.

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.

Author(s)

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

See Also

workbook, createName, existsName, removeName

Examples

## Not run: 
# 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"))

## End(Not run)

XLConnect documentation built on Sept. 11, 2024, 8:04 p.m.