XML API - pdx:addStructuredDocumentTag

pdx:addStructuredDocumentTag

Inserts different types of Structured Document Tags into the Word document.

Note

You are reading the XML API documentation. For the PHP API method please go to addStructuredDocumentTag.

Description

Element definition

This element allows to insert structured document tags (sdt) of various kinds into your Word document:

  • checkboxes
  • combo boxes
  • date pickers
  • dropdown lists
  • rich text

Attributes and sub-elements

sdtType

Possible values are:

  • checkbox
  • comboBox
  • date
  • dropdownList
  • richText

For a detailed description of the available date formats for the date picker structured document tag, please, check the documentation of the addDateAndHour element.

options

Specific options for structured document tags:

Key Description
alias The label that will be shown in the structured document tag.
calendar Calendar type. Default type is gregorian. Possible values include: gregorian, hijri, hebrew, taiwan, japan, thai, korea, saka, gregorianXlitEnglish, gregorianXlitFrench.
dateFormat The default date format is M/d/yyyy. See addDateAndHour for available date formats.
listItems An array of arrays each one of them containing the text to show and value.
local ISO code. The default value is en-US.
lock Locking properties:
  • sdtLocked (cannot be deleted).
  • contentLocked (contents cannot be edited directly).
  • unlocked (default value: no locking).
  • sdtContentLocked (contents cannot be directly edited or the structured tag removed).
placeholderText Text to be shown by default.
tag A programmatic tag.
temporary If true the structured tag is removed after editing.
rawWordML If true one may store the output into a variable.

This is an array including all general paragraph wide options.

The possible keys and values of this array are:

Key Description
pStyle Word style to be used. Run parseStyles() method to check all available paragraph styles.
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).
doubleStrikeThrough If true displays text in doubleStrikeThrough.
em Emphasis mark type: 'none', 'dot', 'circle', 'comma', 'underDot'.
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 you 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 120, 240 (standard), 360, 480... (in twentieths of a point).
pageBreakBefore If true forces a page break before the paragraph.
position Position value. Positive value for raised and negative value for lowered.
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.
spacingBottom Bottom padding in twentieths of a point.
spacingTop Top padding in twentieths of a point.
strikeThrough If true displays text in strikethrough.
tabPositions Each entry is an associative array with the following keys and values:
  • 'type' (string) can be clear, left (default), center, right, decimal, bar and num.
  • 'leader' (string) can be none (default), dot, hyphen, underscore, heavy and middleDot.
  • 'position' (int) given in twentieths of a point.
If there is a tab and the tabPositions array is not defined the standard tab position (default of 708) will be used.
textAlign Text alignment within paragraph. 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.
underlineColor Underlines text with a color: 'FF0000', '000000'...
vanish Uses a vanish style.
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

PHP code

The resulting Word document looks like: