officer: fp_text – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

officer

fp_text

Text formatting properties

Description

Create a fp_text object that describes text formatting properties.

Usage

fp_text(
  color = "black",
  font.size = 10,
  bold = FALSE,
  italic = FALSE,
  underlined = FALSE,
  font.family = "Arial",
  cs.family = NULL,
  eastasia.family = NULL,
  hansi.family = NULL,
  vertical.align = "baseline",
  shading.color = "transparent"
)

## S3 method for class 'fp_text'
format(x, type = "wml", ...)

## S3 method for class 'fp_text'
print(x, ...)

## S3 method for class 'fp_text'
update(
  object,
  color,
  font.size,
  bold,
  italic,
  underlined,
  font.family,
  cs.family,
  eastasia.family,
  hansi.family,
  vertical.align,
  shading.color,
  ...
)

Arguments

`color`	font color - a single character value specifying a valid color (e.g. "#000000" or "black").
`font.size`	font size (in point) - 0 or positive integer value.
`bold`	is bold
`italic`	is italic
`underlined`	is underlined
`font.family`	single character value. Specifies the font to be used to format characters in the Unicode range (U+0000-U+007F).
`cs.family`	optional font to be used to format characters in a complex script Unicode range. For example, Arabic text might be displayed using the "Arial Unicode MS" font.
`eastasia.family`	optional font to be used to format characters in an East Asian Unicode range. For example, Japanese text might be displayed using the "MS Mincho" font.
`hansi.family`	optional. Specifies the font to be used to format characters in a Unicode range which does not fall into one of the other categories.
`vertical.align`	single character value specifying font vertical alignments. Expected value is one of the following : default `'baseline'` or `'subscript'` or `'superscript'`
`shading.color`	shading color - a single character value specifying a valid color (e.g. "#000000" or "black").
`x`	`fp_text` object
`type`	output type - one of 'wml', 'pml', 'html'.
`...`	further arguments - not used
`object`	`fp_text` object to modify
`format`	format type, wml for MS word, pml for MS PowerPoint and html.

Value

a fp_text object

Examples

fp_text()
fp_text(color = "red")
fp_text(bold = TRUE, shading.color = "yellow")
print( fp_text (color="red", font.size = 12) )

officer

Manipulation of Microsoft Word and PowerPoint Documents

v0.3.18

GPL-3

Authors

David Gohel [aut, cre], Frank Hangler [ctb] (function body_replace_all_text), Liz Sander [ctb] (several documentation fixes), Anton Victorson [ctb] (fixes xml structures), Jon Calder [ctb] (update vignettes), John Harrold [ctb] (function annotate_base), John Muschelli [ctb] (google doc compatibility)

Initial release

fp_text

Description

Usage

Arguments

Value

See Also

Examples

officer

We don't support your browser anymore