setSheetColor-methods

0th

Percentile

Setting colors on worksheet tabs

Sets a color on a specified worksheet tab. This only works for xlsx files.

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

The '>workbook to use

sheet

The name or index of the sheet on which to set the tab color

color

The color to use for the sheet tab. The color is normally specified via a corresponding color constant from the XLC object.

See Also

'>workbook, XLC

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

# Create a worksheet named 'Sheet1'
createSheet(wb, name = "Sheet1")

# Set the "Sheet1" tab color as red
setSheetColor(wb, "Sheet1", XLC$COLOR.RED)

# Create a worksheet named 'Sheet2'
createSheet(wb, name = "Sheet2")

# Set the tab color of the second workbook sheet as green
setSheetColor(wb, 2, XLC$COLOR.GREEN)

# Save workbook (this actually writes the file to disk)
saveWorkbook(wb)
# }
Documentation reproduced from package XLConnect, version 0.2-15, License: GPL-3

Community examples

Looks like there are no examples yet.