pdx:addFormElement Inserts form elements into the Word document

pdx:addFormElement

Inserts form elements into the Word document.

Description

Element definition

<pdx:content>
    <pdx:addFormElement pdx:formElementType="textfield|checkbox|select" pdx:defaultValue="" pdx:wordFragmentName="">
        <pdx:options>
            <pdx:item>Item</pdx:item>
            <pdx:item>Other item</pdx:item>
        </pdx:options>
        <pdx:paragraphStyle />
    </pdx:addFormElement>
</pdx:content>

This method allows to insert form elements of various kinds into your Word document:

text fields,
check boxes and
select fields.

If one wishes to insert a form element within a complex paragraph one should use this method in combination with the addText method.

Attributes and sub-elements

type

Possible values are:

textfield
checkbox
select

options

Specific options for form elements:

key	Description
defaultValue	A string of text for the textfield type, a boolean value for the checkbox type or an integer representing the index (0 based) for the options of a select form element.
selectOptions	An array of options for the dropdown menu.

type

key	Description
pStyle	Word style to be used. Run parseStyles() method to check all available paragraph styles
bidi	Set to true for right to left languages (default value is false).
bold	Bold text: true or false
rtl	Set to true for right to left languages (default value is false).
color	Hexadecimal color value: 'FF0000', '000000'...
contextualSpacing	Set to true for right to left languages (default value is false).
font	Font family: 'Arial', Calibri'...
italic	Italics: 'on' or 'off'
indentLeft	Left margin in points
indentRight	Left margin in points
textAlign	Text alignment. Possible values are: 'center', 'right', 'both', 'distribute'
keepLines	Keeps (whenever possible) all the current paragraph lines on the same page: 'on' or 'off' (default)
keepNext	Keeps (whenever possible) in the same page the current paragraph with next paragraph: 'on' or 'off' (default)
lineSpacing	Separation between lines: 240 (single spacing), 480 (double spacing and so long so forth.
pageBreakBefore	Forces a page break before the paragraph. 'on' or 'off'
spacingBottom	Bottom padding in twentieths of a point
spacingTop	Left margin in points
fontSize	Text size in points: 8, 9, 10...
underline	Underline 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): true or false
wordWrap	Controls word wrapping: true or 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:addFormElement pdx:formElementType="textfield" pdx:defaultValue="This is a test">
            <pdx:paragraphStyle>
                <pdx:color pdx:value="0000CC" />
                <pdx:fontSize pdx:value="12" />
                <pdx:italic pdx:value="true" />
                <pdx:bold pdx:value="true" />
                <pdx:font pdx:value="Arial" />
            </pdx:paragraphStyle>
        </pdx:addFormElement>
        <pdx:addFormElement pdx:formElementType="checkbox" pdx:defaultValue="true">
            <pdx:paragraphStyle>
                <pdx:fontSize pdx:value="12" />
            </pdx:paragraphStyle>
        </pdx:addFormElement>
        <pdx:addFormElement pdx:formElementType="select" pdx:defaultValue="true">
            <pdx:options>
                <pdx:item>One</pdx:item>
                <pdx:item>Two</pdx:item>
                <pdx:item>Three</pdx:item>
                <pdx:item>Four</pdx:item>
            </pdx:options>
            <pdx:paragraphStyle>
                <pdx:color pdx:value="C90000" />
                <pdx:fontSize pdx:value="14" />
                <pdx:bold pdx:value="true" />
                <pdx:font pdx:value="Algerian" />
                <pdx:underline pdx:value="double" />
            </pdx:paragraphStyle>
        </pdx:addFormElement>
    </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>

import os as os
import sys as sys
sys.path.append(os.path.abspath("wrappers/python/XmlDocx"))
import XmlDocx as XmlDocx
document = XmlDocx.XmlDocx("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render()

The resulting Word document looks like: