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
39
40
41
42
43
44
45
46
47
48
49
50
51
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CommentClass.R
\name{createComment}
\alias{createComment}
\title{create a Comment object}
\usage{
createComment(
comment,
author = Sys.getenv("USERNAME"),
style = NULL,
visible = TRUE,
width = 2,
height = 4
)
}
\arguments{
\item{comment}{Comment text. Character vector.}
\item{author}{Author of comment. Character vector of length 1}
\item{style}{A Style object or list of style objects the same length as comment vector. See \code{\link[=createStyle]{createStyle()}}.}
\item{visible}{TRUE or FALSE. Is comment visible.}
\item{width, height}{Width and height of textbook (in number of cells);
doubles are rounded with \code{base::round()}}
}
\description{
Create a cell Comment object to pass to writeComment()
}
\examples{
wb <- createWorkbook()
addWorksheet(wb, "Sheet 1")
c1 <- createComment(comment = "this is comment")
writeComment(wb, 1, col = "B", row = 10, comment = c1)
s1 <- createStyle(fontSize = 12, fontColour = "red", textDecoration = c("BOLD"))
s2 <- createStyle(fontSize = 9, fontColour = "black")
c2 <- createComment(comment = c("This Part Bold red\n\n", "This part black"), style = c(s1, s2))
c2
writeComment(wb, 1, col = 6, row = 3, comment = c2)
\dontrun{
saveWorkbook(wb, file = "createCommentExample.xlsx", overwrite = TRUE)
}
}
\seealso{
\code{\link[=writeComment]{writeComment()}}
}
|
