pdx:removeChapter Removes a whole chapter from a Word document

pdx:removeChapter

Removes a whole chapter from a Word document.

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 we 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/xmldocx/samples/files/headings.docx" pdx:target="/var/www/xmldocx/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>

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.render()

The resulting Word document looks like: