Setting the active worksheet in a workbook

Sets the active worksheet of a workbook.

Usage

# S4 method for class 'workbook,character'
setActiveSheet(object,sheet)
# S4 method for class 'workbook,numeric'
setActiveSheet(object,sheet)

Arguments

object

The workbook to use

sheet

The name or index of the sheet to activate

Author

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

Note

The active worksheet of a workbook is the worksheet that is displayed when the corresponding Excel file is opened.

See also

workbook, createSheet, removeSheet, renameSheet, existsSheet, getSheets

Examples

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

# Load workbook
wb <- loadWorkbook(mtcarsFile)

# Sets the active sheet to the sheet 'mtcars3'
setActiveSheet(wb, sheet = "mtcars3")
} # }