XML API - pdx:addText

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addText

Inserts a paragraph into a Word document.

Note

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

Description

Element definition

<pdx:content>
    <pdx:addText pdx:wordFragmentName="">
        <pdx:textRun>
            <pdx:data pdx:dataId="" pdx:dataType="text|wordFragment">text</pdx:data>
            <pdx:textRunStyle>
                <pdx:bold pdx:value="" />
                <pdx:caps pdx:value="" />
                <pdx:color pdx:value="" />
                <pdx:doubleStrikeThrough pdx:value="" />
                <pdx:em pdx:value="" />
                <pdx:font pdx:value="" />
                <pdx:fontSize pdx:value="" />
                <pdx:highlightColor pdx:value="" />
                <pdx:italic pdx:value="" />
                <pdx:lang pdx:value="" />
                <pdx:lineBreak pdx:value="after|before|both" />
                <pdx:position pdx:value="" />
                <pdx:rStyle pdx:value="" />
                <pdx:rtl pdx:value="" />
                <pdx:scaling pdx:value="" />
                <pdx:smallCaps pdx:value="" />
                <pdx:spaces pdx:value="" />
                <pdx:spacing pdx:value="" />
                <pdx:strikeThrough pdx:value="" />
                <pdx:subscript pdx:value="" />
                <pdx:superscript pdx:value="" />
                <pdx:tab pdx:value="" />
                <pdx:underline pdx:value="" />
                <pdx:underlineColor pdx:value="" />
                <pdx:vanish pdx:value="" />
            </pdx:textRunStyle>
        </pdx:textRun>
        <pdx:textRun>
            <pdx:data pdx:dataId="" pdx:dataType="text|wordFragment">text</pdx:data>
            <pdx:textRunStyle>
                <pdx:bold pdx:value="" />
                <pdx:caps pdx:value="" />
                <pdx:color pdx:value="" />
                <pdx:columnBreak pdx:value="after|before|both" />
                <pdx:doubleStrikeThrough pdx:value="" />
                <pdx:em pdx:value="none|dot|circle|comma|underDot" />
                <pdx:font pdx:value="" />
                <pdx:fontSize pdx:value="" />
                <pdx:highlightColor pdx:value="" />
                <pdx:italic pdx:value="" />
                <pdx:lang pdx:value="" />
                <pdx:lineBreak pdx:value="after|before|both" />
                <pdx:rStyle pdx:value="" />
                <pdx:rtl pdx:value="" />
                <pdx:scaling pdx:value="" />
                <pdx:smallCaps pdx:value="" />
                <pdx:spaces pdx:value="" />
                <pdx:spacing pdx:value="" />
                <pdx:strikeThrough pdx:value="" />
                <pdx:subscript pdx:value="" />
                <pdx:superscript pdx:value="" />
                <pdx:tab pdx:value="" />
                <pdx:underline pdx:value="" />
                <pdx:underlineColor pdx:value="" />
                <pdx:vanish pdx:value="" />
            </pdx:textRunStyle>
        </pdx:textRun>
        <pdx:paragraphStyle>
            <pdx:backgroundColor pdx:value="" />
            <pdx:bidi pdx:value="" />
            <pdx:bold pdx:value="" />
            <pdx:border pdx:color="" pdx:space="" pdx:style="" pdx:width="">
                <pdx:top pdx:color="" pdx:space="" pdx:style="" pdx:width="" />
                <pdx:right pdx:color="" pdx:space="" pdx:style="" pdx:width="" />
                <pdx:bottom pdx:color="" pdx:space="" pdx:style="" pdx:width="" />
                <pdx:left pdx:color="" pdx:space="" pdx:style="" pdx:width="" />
            </pdx:border>
            <pdx:caps pdx:value="" />
            <pdx:color pdx:value="" />
            <pdx:contextualSpacing pdx:value="" />
            <pdx:doubleStrikeThrough pdx:value="" />
            <pdx:em pdx:value="none|dot|circle|comma|underDot" />
            <pdx:firstLineIndent pdx:value="" />
            <pdx:font pdx:value="" />
            <pdx:fontSize pdx:value="" />
            <pdx:hanging pdx:value="" />
            <pdx:headingLevel pdx:value="" />
            <pdx:italic pdx:value="" />
            <pdx:indentLeft pdx:value="" />
            <pdx:indentRight pdx:value="" />
            <pdx:keepLines pdx:value="" />
            <pdx:keepNext pdx:value="" />
            <pdx:lineSpacing pdx:value="" />
            <pdx:pageBreakBefore pdx:value="" />
            <pdx:position pdx:value="" />
            <pdx:pStyle pdx:value="" />
            <pdx:rtl pdx:value="" />
            <pdx:smallCaps pdx:value="" />
            <pdx:spacing pdx:value="" />
            <pdx:spacingBottom pdx:value="" />
            <pdx:spacingTop pdx:value="" />
            <pdx:strikeThrough pdx:value="" />
            <pdx:tabPositions>
                <pdx:tabPosition pdx:type="" pdx:leader="" pdx:position="" />
                <pdx:tabPosition pdx:type="" pdx:leader="" pdx:position="" />
            </pdx:tabPositions>
            <pdx:textAlign pdx:value="center|right|both|distribute" />
            <pdx:textDirection pdx:value="" />
            <pdx:underline pdx:value="" />
            <pdx:underlineColor pdx:value="" />
            <pdx:vanish pdx:value="" />
            <pdx:widowControl pdx:value="" />
            <pdx:wordWrap pdx:value="" />
        </pdx:paragraphStyle>
    </pdx:addText>
</pdx:content>

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 kind 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
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

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.
rtl	Set to true for right to left languages like Hebrew or Arabic.
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

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

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:config>
        <pdx:output pdx:name="output" pdx:type="docx" />
    </pdx:config>
</pdx:document>

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:content>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</pdx:data>
                <pdx:textRunStyle>
                    <pdx:bold pdx:value="true" />
                    <pdx:font pdx:value="Arial" />
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
    </pdx:content>
</pdx:document>

settings.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:settings>
    </pdx:settings>
</pdx:document>

PHP code

require_once 'path_to_phpdocx/classes/CreateDocx.php';

$docx = new XMLAPI('config.xml');
$docx->setDocumentProperties('settings.xml');
$docx->addContent('content.xml');

$docx->render();

The resulting Word document looks like: