wdAddImageCaption: Adds a caption to an image.

Description Usage Arguments TODO Examples

View source: R/addons.R

Description

This function adds a caption to an image.

Usage

1
2
wdAddImageCaption(i, ishp = NULL, title = "", sep = ":",
  label = -1, position = 1, wdapp = .R2wd)

Arguments

i

The number of the image inside the document.

ishp

A pointer to the image. Best used with wdReplaceTextByImage return value.

title

The title of the image.

label

WdCaptionLabelID enumeration. -1 = Figure caption (default). You may use as string for self customized captions.

position

0=above, 1=below (default).

TODO

check if captions exists and replace it.

Examples

1
2
3
file <- system.file("inst/template.docx", package = "R2wdaddons")
wdGet2(file)
wdAddImageCaption(i = 1, title = "My image")

markheckmann/R2wdaddons documentation built on Sept. 13, 2019, 8:40 a.m.