XML API - pdx:searchAndHighlight

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:searchAndHighlight

Searches for keywords within a Word document and highlights them.

Note

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

Description

Element definition

<pdx:utilities>
    <pdx:searchAndHighlight pdx:src="" pdx:target="" pdx:searchTerm="" pdx:highlightColor="">
        <pdx:valueContext pdx:value="" />
        <pdx:valueContext pdx:value="" />
    </pdx:searchAndHighlight>
</pdx:utilities>

This element allows the highlighting 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 highlight.

options

The possible keys and values are:

Key	Description
highlightColor	the color used for the highlighting: black blue cyan green magenta red yellow white darkBlue darkCyan darkGreen darkMagenta darkRed darkYellow darkGray lightGray none The default value is ‘yellow’.
document	If true highlights the search string in the body of the document. The default value is true.
endnotes	If true highlights the search string in the document endnotes. The default value is false.
comments	If true highlights the search string in the document comments. The default value is false.
headersAndFooters	If true highlights the search string in headers and footers. The default value is true.
footnotes	If true highlights the search 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:searchAndHighlight pdx:source="/var/www/phpdocx/samples/files/second.docx" pdx:target="/var/www/phpdocx/samples/DocxUtilities/searchAndHighlight/output_searchAndHighlight.docx" pdx:searchTerm="data" pdx:highlightColor="green">
            <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:searchAndHighlight>
    </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: