XML API - pdx:parseCheckboxes

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:parseCheckboxes

Ticks or unticks a checkbox in a Word template.

Note

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

Description

Element definition

<pdx:utilities>
    <pdx:parseCheckboxes pdx:source="" pdx:target="">
        <pdx:checkbox pdx:value="" />
        <pdx:checkbox pdx:value="" />
    </pdx:parseCheckboxes>
</pdx:utilities>

This element allows to modify the state of all the checkboxes of a given Word document.

It allows the modification of:

legacy checkboxes
Word 2010 checkboxes

The checkboxes are parsed sequentally, as they show in the Word document, and their final state is defined by the $checkboxes array of 0's and 1's (unchecked or checked respectively).

If the length of the $checkboxes array is shorter than the total number of checkboxes the "extra" one will be ignored and left in their current state.

Attributes and sub-elements

source

The path to the Word document that you want to parse.

target

The path to the resulting Word document.

checkboxes

Possible values: 1 (tick) or 0 (untick).

In principle, this should have as many entries as checkboxes in the Word document. If there are less the last checkboxes will be ignored and if there are more the extra values will be ignored.

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:utilities>
        <pdx:parseCheckboxes pdx:source="/var/www/phpdocx/samples/files/Checkbox.docx" pdx:target="/var/www/phpdocx/samples/DocxUtilities/parseCheckboxes/output_parsecheckboxes.docx">
            <pdx:checkbox pdx:value="0" />
            <pdx:checkbox pdx:value="1" />
            <pdx:checkbox pdx:value="1" />
        </pdx:parseCheckboxes>
    </pdx:utilities>
</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: