pdx:addText

Inserts a paragraph into a Word document.

Description

Element definition

This element allows the insertion of a paragraph into a Word document.

You may include in your paragraph:

  • multiple runs of text with diverse formatting,
  • inline and floating images,
  • inline and floating charts,
  • footnotes and endnotes,
  • all kinds of different line breaks (line, column, page),
  • all kind of different tabs (light, right, center with leading characters or not),
  • links and bookmarks,
  • page numbers,
  • date and hour,
  • form elements,
  • shapes and
  • inline HTML content.

You may, in general, insert any "inline" element. If you try to insert a block type element, like a table, its inline contents will be extracted and inserted ignoring the containing block element.

Attributes and sub-elements

paragraphContents

This could be:

  • a simple string of text,
  • a WordFragment or
key Description
text The text to be inserted.
bold If true the text will be shown in bold characters.
caps If true displays text in capital letters.
characterBorder Adds a border to the character. Attributes and values: 'type' => none, single, double, dashed..., 'color' => ffffff, ff0000, 'spacing'=> 0, 1, 2..., 'width' => in eights of a point
color Hexadecimal color value: 'FF0000', '000000', ...
columnBreak

Inserts a column break.

Possible values are: before, after or both.

doubleStrikeThrough If true displays text in doubleStrikeThrough.
em Emphasis mark type: 'none', 'dot', 'circle', 'comma', 'underDot'
font Font family: 'Arial', Calibri', ...
fontSize Font size in points.
highlightColor

Highlights the run of text.

The available colors are: black, blue, cyan, green, magenta, red, yellow, white, darkBlue, darkCyan, darkGreen, darkMagenta, darkRed, darkYellow, darkGray, lightGray, none.

italic If true displays the text in italics.
lineBreak Inserts a line break. Possible values are: before, after or both.
position Position value. Positive value for raised and negative value for lowered.
rStyle Character style to be used.
rtl Set to true for right to left languages like Hebrew or Arabic.
scaling Scaling value, 100 is the default value.
smallCaps If true displays text in small capital letters.
spaces Number of additional leading empty spaces before the current run of text.
spacing character spacing, positive value for expanded and negative value for condensed.
strikeThrough If true displays text in strikethrough.
subscript If true displays text in subscript.
superscript If true displays text in superscript.
tab Inserts a tab.
underline Underlines text. Possible values are: single, words, double, dotted, dash and wave.
underlineColor Underlines text with a color: 'FF0000', '000000', ...
vanish Uses a vanish style.

paragraphOptions

The possible keys and values are:

key Description
pStyle The WordML fragment object containing the contents for the even pages header
backgroundColor Hexadecimal color value: FF0000, 000000...
bidi Set to true for right to left languages like Hebrew or Arabic.
bold If true the text will be shown in bold characters.
border Available values are:
  • none (default)
  • double
  • dashed
  • outset
  • inset
  • threeDEmboss
  • threeDEngrave
You can access to the complete list in: Border Styles.
borderBottom Overwrites the general border type for the bottom border of the paragraph.
borderLeft Overwrites the general border type for the left border of the paragraph.
borderTop Overwrites the general border type for the top border of the paragraph.
borderRight Overwrites the general border type for the right border of the paragraph.
borderColor Hexadecimal color value: FF0000, 000000...
borderBottomColor Overwrites the general border color for the bottom border of the paragraph.
borderLeftColor Overwrites the general border color for the left border of the paragraph.
borderTopColor Overwrites the general border color for the top border of the paragraph.
borderRightColor Overwrites the general border color for the right border of the paragraph.
borderSpacing Separation between border and text in points.
borderBottomSpacing Overwrites the general border spacing for the bottom border of the paragraph.
borderLeftSpacing Overwrites the general border spacing for the left border of the paragraph.
borderTopSpacing Overwrites the general border spacing for the top border of the paragraph.
borderRightSpacing Overwrites the general border spacing for the right border of the paragraph.
borderWidth Border width in eigths of a point.
borderBottomWidth Overwrites the general border width for the bottom border of the paragraph.
borderLeftWidth Overwrites the general border width for the left border of the paragraph.
borderTopWidth Overwrites the general border width for the top border of the paragraph.
borderRightWidth Overwrites the general border width for the right border of the paragraph.
caps If true displays text in capital letters.
color Hexadecimal color value: 'FF0000', '000000'...
contextualSpacing If true ignores spacing above and below the paragraph whenever the neighbouring paragraphs use the same Word style (false by default).
firstLineIndent First line indentation in twentieths of a point (twips).
font Font family: 'Arial', Calibri'...
fontSize Font size in points.
hanging Paragraph hanging in twentieths of a point (twips).
headingLevel The heading level if we want this paragraph to be a heading.
italic If true displays the text in italics.
indentLeft Left margin in points.
indentRight Right margin in points
keepLines Keeps (whenever possible) all the current paragraph lines on the same page (default value is false).
keepNext Keeps (whenever possible) in the same page the current paragraph with next paragraph (default value is false).
lineSpacing 1 corresponds to single line spacing, 2 to double line spacing and so long so forth. It admits decimal numbers.
pageBreakBefore If true forces a page break before the paragraph.
rtl Set to true for right to left languages like Hebrew or Arabic.
smallCaps If true displays text in small capital letters.
spacingBottom Bottom padding in twentieths of a point
spacingTop Top padding in twentieths of a point
textAlign Text alignment within paragraphs. Possible values are: center, right, both and distribute.
textDirection Text flow direction within a table cell. Possible values are: lrTb, tbRl, btLr, lrTbV, tbRlV and tbLrV.
underline Underlines text. Possible values are: single, words, double, dotted, dash and wave.
widowControl Prevents Word from printing the last line of a paragraph by itself at the top of the page (widow) or the first line of a paragraph at the bottom of a page (orphan).
wordWrap Allows line breaking at character level (default value is false).
Code samples
#Example 1

config.xml

content.xml

settings.xml

The resulting Word document looks like: