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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/helperFunctions.R
\name{makeHyperlinkString}
\alias{makeHyperlinkString}
\title{create Excel hyperlink string}
\usage{
makeHyperlinkString(sheet, row = 1, col = 1, text = NULL, file = NULL)
}
\arguments{
\item{sheet}{Name of a worksheet}
\item{row}{integer row number for hyperlink to link to}
\item{col}{column number of letter for hyperlink to link to}
\item{text}{display text}
\item{file}{Excel file name to point to. If NULL hyperlink is internal.}
}
\description{
Wrapper to create internal hyperlink string to pass to writeFormula(). Either link to external urls or local files or straight to cells of local Excel sheets.
}
\examples{
## Writing internal hyperlinks
wb <- createWorkbook()
addWorksheet(wb, "Sheet1")
addWorksheet(wb, "Sheet2")
addWorksheet(wb, "Sheet 3")
writeData(wb, sheet = 3, x = iris)
## External Hyperlink
x <- c("https://www.google.com", "https://www.google.com.au")
names(x) <- c("google", "google Aus")
class(x) <- "hyperlink"
writeData(wb, sheet = 1, x = x, startCol = 10)
## Internal Hyperlink - create hyperlink formula manually
writeFormula(
wb, "Sheet1",
x = '=HYPERLINK(\"#Sheet2!B3\", "Text to Display - Link to Sheet2")',
startCol = 3
)
## Internal - No text to display using makeHyperlinkString() function
writeFormula(
wb, "Sheet1",
startRow = 1,
x = makeHyperlinkString(sheet = "Sheet 3", row = 1, col = 2)
)
## Internal - Text to display
writeFormula(
wb, "Sheet1",
startRow = 2,
x = makeHyperlinkString(
sheet = "Sheet 3", row = 1, col = 2,
text = "Link to Sheet 3"
)
)
## Link to file - No text to display
writeFormula(
wb, "Sheet1",
startRow = 4,
x = makeHyperlinkString(
sheet = "testing", row = 3, col = 10,
file = system.file("extdata", "loadExample.xlsx", package = "openxlsx")
)
)
## Link to file - Text to display
writeFormula(
wb, "Sheet1",
startRow = 3,
x = makeHyperlinkString(
sheet = "testing", row = 3, col = 10,
file = system.file("extdata", "loadExample.xlsx", package = "openxlsx"),
text = "Link to File."
)
)
## Link to external file - Text to display
writeFormula(
wb, "Sheet1",
startRow = 10, startCol = 1,
x = '=HYPERLINK("[C:/Users]", "Link to an external file")'
)
## Link to internal file
x = makeHyperlinkString(text = "test.png", file = "D:/somepath/somepicture.png")
writeFormula(wb, "Sheet1", startRow = 11, startCol = 1, x = x)
\dontrun{
saveWorkbook(wb, "internalHyperlinks.xlsx", overwrite = TRUE)
}
}
\seealso{
\code{\link[=writeFormula]{writeFormula()}}
}
|