XML API - pdx:removeChapter

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:removeChapter

Removes a whole chapter from a Word document.

Note

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

Description

Element definition

<pdx:utilities>
    <pdx:removeChapter pdx:src="" pdx:target="" pdx:searchTerm="" />
</pdx:utilities>

This element allows to remove (sub)chapters which corresponding heading contains a certain string of text.

This element finds all headings with the required string of text and removes all contents until one hits a new heading of the same or lower level.

Attributes and sub-elements

src

The path to the source Word document.

target

The path to the resulting Word document.

searchTerm

The string of text that you want to search in the headings.

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:removeChapter pdx:source="/var/www/phpdocx/samples/files/headings.docx" pdx:target="/var/www/phpdocx/samples/DocxUtilities/removeChapter/output_removeChapter.docx" pdx:searchTerm="First Heading" />
    </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: