XML API - pdx:searchAndReplace

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:searchAndReplace

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

Note

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

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 highlighting.

searchTerm

The string of text that you want to replace.

replaceTerm

The string of text that you want to include.

options

Key	Description
document	If true searches and replaces the string in the body of the document. The default value is true.
endnotes	If true searches and replaces the string in the document endnotes. The default value is false.
comments	If true searches and replaces the string in the document comments. The default value is false.
headersAndFooters	If true searches and replaces the string in headers and footers. The default value is true.
footnotes	If true searches 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/phpdocx/samples/files/second.docx" pdx:target="/var/www/phpdocx/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>

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: