XML API - pdx:modifyInputFields

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:modifyInputFields

Modifies the values associated with Word template input fields.

Note

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

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate="">
    <pdx:modifyInputFields>
        <pdx:inputField pdx:variableName="">
            <pdx:data pdx:dataId="" pdx:dataType="text">text</pdx:data>
        </pdx:inputField>
        <pdx:inputField pdx:variableName="">
            <pdx:data pdx:dataId="" pdx:dataType="text">text</pdx:data>
        </pdx:inputField>
    </pdx:modifyInputFields>
</pdx:templateVariables>

This element allows to modify the value of a series of Word input fields.

In combination with the tickCheckbox element allows to fill all data of a standard web form.

This element is also compatible with Word legacy input fields.

Attributes and sub-elements

variableName

The name of the variable.

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:template pdx:path="/var/www/phpdocx/samples/files/inputFields.docx" />
        <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:templateVariables pdx:preprocessedTemplate="">
        <pdx:modifyInputFields>
            <pdx:inputField pdx:variableName="textfield_1">
                <pdx:data pdx:dataId="" pdx:dataType="text">first</pdx:data>
            </pdx:inputField>
            <pdx:inputField pdx:variableName="textfield_2">
                <pdx:data pdx:dataId="" pdx:dataType="text">second</pdx:data>
            </pdx:inputField>
            <pdx:inputField pdx:variableName="sdt_1">
                <pdx:data pdx:dataId="" pdx:dataType="text">third</pdx:data>
            </pdx:inputField>
            <pdx:inputField pdx:variableName="sdt_2">
                <pdx:data pdx:dataId="" pdx:dataType="text">fourth</pdx:data>
            </pdx:inputField>
        </pdx:modifyInputFields>
    </pdx:templateVariables>
</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: