searchAndHighlight

LAYOUT & GENERAL
WORD CONTENT
TEMPLATES
FORMAT CONVERSION
DOCXPATH
DOCXUTILITIES
DOCXPATHUTILITIES
PDFUTILITIES
DOCXCUSTOMIZER
PERFORMANCE
BULK PROCESSING
TRACKING
CRYPTOPHPDOCX
DIGITAL SIGNATURE
ARTIFICIAL INTELLIGENCE
XLSXUTILITIES
PPTXUTILITIES
BLOCKCHAIN
VARIANT

searchAndHighlight

ADVANCED / PREMIUM TRIAL

Searches for keywords within a Word document and highlights them.

Description
public searchAndHighlight (string $source, string $target, string $search [, array $options])

This method allows the highlighting of plain text in a DOCX document.

Parameters

Source

The path to the source Word document.

target

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

search

The string of text or array that you want to highlight.

options

The possible keys and values are:

Key Type Description
highlightColor string

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 bool If true highlights the search string in the body of the document. The default value is true.
endnotes bool If true highlights the search string in the document endnotes. The default value is false.
comments bool If true highlights the search string in the document comments. The default value is false.
headersAndFooters bool If true highlights the search string in headers and footers. The default value is false.
footnotes bool If true highlights the search string in the document footnotes. The default value is false.
headers bool If true highlights the search string in headers. The default value is false.
footers bool If true highlights the search string in footers. The default value is false.
Exceptions

Error while trying to open the (base) template as a zip file.

Code samples

Example #1

The resulting Word document looks like: