File: activeSheet.Rd

package info (click to toggle)
r-cran-openxlsx 4.2.8-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,328 kB
  • sloc: cpp: 1,867; makefile: 2
file content (38 lines) | stat: -rw-r--r-- 813 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/wrappers.R
\name{activeSheet}
\alias{activeSheet}
\alias{activeSheet<-}
\title{Get/set active sheet of the workbook}
\usage{
activeSheet(wb)

activeSheet(wb) <- value
}
\arguments{
\item{wb}{A workbook object}

\item{value}{index of the active sheet or name of the active sheet}
}
\value{
return the active sheet of the workbook
}
\description{
Get and set active sheet of the workbook
}
\examples{

wb <- createWorkbook()
addWorksheet(wb, sheetName = "S1")
addWorksheet(wb, sheetName = "S2")
addWorksheet(wb, sheetName = "S3")

activeSheet(wb) # default value is the first sheet active
activeSheet(wb) <- 1 ## active sheet S1
activeSheet(wb)
activeSheet(wb) <- "S2" ## active sheet S2
activeSheet(wb)
}
\author{
Philipp Schauberger
}