isSheetVisible-methods

0th

Percentile

Checking if worksheets are visible in a workbook

Checks if the specified worksheets are visible in a '>workbook.

Keywords
methods, utilities
Usage
# S4 method for workbook,character
isSheetVisible(object,sheet)
# S4 method for workbook,numeric
isSheetVisible(object,sheet)
Arguments
object

The '>workbook to use

sheet

The name or index of the sheet to check

Details

Returns TRUE if the specified named sheet is visible (not hidden and not very hidden), otherwise FALSE. sheet is vectorized such that multiple worksheets can be queried with one method call. An exception is thrown if the specified sheet does not exist.

See Also

'>workbook, hideSheet, unhideSheet, isSheetHidden, isSheetVeryHidden

Aliases
  • isSheetVisible
  • isSheetVisible-methods
  • isSheetVisible,workbook,character-method
  • isSheetVisible,workbook,numeric-method
Examples
# NOT RUN {
# Load workbook (create if not existing)
wb <- loadWorkbook("isSheetVisible.xlsx", create = TRUE)

# Write a couple of built-in data.frame's into sheets
# with corresponding name
for(obj in c("CO2", "airquality", "swiss")) {
  createSheet(wb, name = obj)
  writeWorksheet(wb, get(obj), sheet = obj)
}

# Hide sheet 'CO2'
hideSheet(wb, sheet = "CO2", veryHidden = FALSE)

# Very hide sheet 'airquality'
hideSheet(wb, sheet = "airquality", veryHidden = TRUE)

# Check if sheet 'swiss' is visible;
# this should obviously return TRUE
isSheetVisible(wb, "swiss")

# Check if sheet 'CO2' is visible;
# this should obviously return FALSE
isSheetVisible(wb, "CO2")

# Check if sheet 'airquality' is visible;
# this should obviously return FALSE
isSheetVisible(wb, "airquality")

# }
Documentation reproduced from package XLConnect, version 0.2-14, License: GPL-3

Community examples

Looks like there are no examples yet.