xlsx (version 0.6.5)

Comment: Functions to manipulate cell comments.

Description

These functions are not vectorized.

Usage

createCellComment(cell, string, author = NULL, visible = TRUE)
removeCellComment(cell)
getCellComment(cell)

Arguments

cell

a Cell object.

string

a string for the comment.

author

a string with the author's name

visible

a logical value. If TRUE the comment will be visible.

Value

createCellComment creates a Comment object.

getCellComment returns a the Comment object if it exists.

removeCellComment removes a comment from the given cell.

See Also

For cells, see Cell. To format cells, see CellStyle.

Examples

# NOT RUN {

  wb <- createWorkbook()
  sheet1 <- createSheet(wb, "Sheet1")
  rows   <- createRow(sheet1, rowIndex=1:10)     # 10 rows
  cells  <- createCell(rows, colIndex=1:8)       # 8 columns

  cell1 <- cells[[1,1]]
  setCellValue(cell1, 1)   # add value 1 to cell A1

  # create a cell comment
  createCellComment(cell1, "Cogito", author="Descartes")


  # extract the comments
  comment <- getCellComment(cell1)
  stopifnot(comment$getAuthor()=="Descartes")
  stopifnot(comment$getString()$toString()=="Cogito")

  # don't forget to save your workbook!

# }