Querying the coordinates of the range reference by an Excel name

Queries the coordinates of an Excel named range in a workbook.

# S4 method for class 'workbook'
getReferenceCoordinatesForName(object,name, worksheetScope)

Arguments

object

The workbook to use

name

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

worksheetScope

Optional, the name of the worksheet to use for resolving the named region

Details

If worksheetScope is defined, only coordinates for a range scoped strictly to the specified worksheet are returned. To explicitly only query for named ranges in the global scope, pass "" as the value.

Author

Thomas Themel
Mirai Solutions GmbH https://mirai-solutions.ch

See also

workbook, createName, existsName, removeName, getReferenceFormula, getReferenceCoordinatesForTable

Examples

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

# Load workbook
wb <- loadWorkbook(demoExcelFile)

# Query reference coordinate for name 'mtcars'
print(getReferenceCoordinatesForName(wb, name = "mtcars"))
} # }