fp_par: Paragraph formatting properties

Description Usage Arguments Value Examples

View source: R/fp_par.R

Description

Create a fp_par object that describes paragraph formatting properties.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
fp_par(text.align = "left", padding = 0, border = fp_border(width = 0),
  padding.bottom, padding.top, padding.left, padding.right, border.bottom,
  border.left, border.top, border.right, shading.color = "transparent")

## S3 method for class 'fp_par'
dim(x)

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

## S3 method for class 'fp_par'
update(object, text.align, padding, border, padding.bottom,
  padding.top, padding.left, padding.right, border.bottom, border.left,
  border.top, border.right, shading.color, ...)

Arguments

text.align

text alignment - a single character value, expected value is one of 'left', 'right', 'center', 'justify'.

padding

paragraph paddings - 0 or positive integer value. Argument padding overwrites arguments padding.bottom, padding.top, padding.left, padding.right.

border

shortcut for all borders.

padding.bottom, padding.top, padding.left, padding.right

paragraph paddings - 0 or positive integer value.

border.bottom, border.left, border.top, border.right

fp_border for borders. overwrite other border properties.

shading.color

shading color - a single character value specifying a valid color (e.g. "#000000" or "black").

x, object

fp_par object

...

further arguments - not used

Value

a fp_par object

Examples

1
2
3
fp_par(text.align = "center", padding = 5)
obj <- fp_par(text.align = "center", padding = 1)
update( obj, padding.bottom = 5 )

Example output

                    values
text.align          center
padding.top              5
padding.bottom           5
padding.left             5
padding.right            5
shading.color  transparent
borders:
       width color style
top        0 black solid
bottom     0 black solid
left       0 black solid
right      0 black solid
                    values
text.align          center
padding.top              1
padding.bottom           5
padding.left             1
padding.right            1
shading.color  transparent
borders:
       width color style
top        0 black solid
bottom     0 black solid
left       0 black solid
right      0 black solid

officer documentation built on July 24, 2018, 9:02 a.m.