pdx:searchAndReplace Searches and replaces a given string of text in a Word document

pdx:searchAndReplace

Searches and replaces a given string of text in a Word document.

Description

Element definition

<pdx:utilities>
    <pdx:searchAndReplace pdx:src="" pdx:target="" pdx:searchTerm="" pdx:replaceTerm="">
        <pdx:valueContext pdx:value="" />
        <pdx:valueContext pdx:value="" />
    </pdx:searchAndReplace>
</pdx:utilities>

This element allows the substitution of plain text in a DOCX document.

Attributes and sub-elements

src

The path to the source Word document.

target

The path to the Word document resulting after the text replacement.

searchTerm

The string of text that we want to replace.

replaceTerm

The string of text that we want to include.

options

key	Description
document	If true searchs and replaces the string in the body of the document. The default value is true.
endnotes	If true searchs and replaces the string in the document endnotes. The default value is false.
comments	If true searchs and replaces the string in the document comments. The default value is false.
headersAndFooters	If true searchs and replaces the string in headers and footers. The default value is true.
footnotes	If true searchs and replaces the string in the document footnotes. The default value is 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:utilities>
        <pdx:searchAndReplace pdx:source="/var/www/xmldocx/samples/files/second.docx" pdx:target="/var/www/xmldocx/samples/DocxUtilities/searchAndReplace/output_searchAndReplace.docx" pdx:searchTerm="data" pdx:replaceTerm="required data">
            <pdx:valueContext pdx:value="document" />
            <pdx:valueContext pdx:value="endnotes" />
            <pdx:valueContext pdx:value="comments" />
            <pdx:valueContext pdx:value="headersAndFooters" />
            <pdx:valueContext pdx:value="footnotes" />
        </pdx:searchAndReplace>
    </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.setXmlDocxPath("xmldocx path")
document.render()

The resulting Word document looks like: