replaceWordContent

replaceWordContent

ADVANCED / PREMIUM BASIC

Replaces existing contents by a WordFragment.

Description
public replaceWordContent (WordFragment $wordFragment, array $referenceNode, [string $location, bool $forceAppend])
Parameters

wordFragment

WordFragment to be inserted.

referenceNode

An array to get the refence node.
The possible keys and values of this array are:

Key Type Description
type string * (all, default value), break, chart, endnote (content reference, the whole paragraph is removed), footnote (content reference, the whole paragraph is removed), image, paragraph (also for bookmarks, links and lists), section, shape, table.
contains string Contains a text string.
occurrence int Exact occurrence (int) or range of contents (e.g.: 2..9, 2.., ..9) (string) or first() or last(). If empty iterate all elements.
attributes array Contains a specific attribute key and value.
parent string Main document body as default, allows to set any parent or a specific one. w:body (default), '/' (any parent) or any other specific parent (/w:tbl/, /w:tc/, /w:r/...).
target string Target content: document (default), header, footer.
reference array To be used with header and footer targets: positions (array) 1, 2... based on the sectPr contents order, sections (array) 1, 2..., types (array) first, even, default
customQuery string Custom xpath query, overwrites any other reference.

location

after (default), before, inlineBefore or inlineAfter. Inline locations don't create a new w:p and add the WordFragment before or after the referenceNode (only inline elements).

forceAppend

If true appends the WordFragment if the reference node could not be found (false as default).

Code samples

Example #1

Example #2