JSON API - replaceWordContent

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

replaceWordContent

PREMIUM

TRIAL / ADVANCED

Replaces existing content with new content in the document.

Note

You are reading the JSON API documentation. For the PHP API method please go to replaceWordContent.

JSON data

{
    "wordfragment": "string",
    "referenceNode": {
        "type": "string",
        "contains": "string",
        "occurrence": number | "string" | array,
        "attributes": array,
        "parent": "string",
        "customQuery": "string",
        "target": "string",
        "reference": array
    },
    "location": "string",
    "forceAppend": boolean
}

Key	Description
wordfragment	WordFragment to be inserted.
referenceNode	Reference node.
type	* (all, default value) break chart endnote (content reference) footnote (content reference) image math paragraph (also for bookmarks, links and lists) section shape table table-row table-cell table-cell-paragraph
contains	Contains a text string.
occurrence	(number) exact occurrence (from 1) (array) occurrences (string) range of contents (e.g.: "2..9", "2..", "..9") or "first()" or "last()"
attributes	Contains a specific attribute key and value.
parent	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	document (default) header footer
reference	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	Custom xpath query, overwrites any other reference.
location	after (default) or before.td>
forceAppend	If true appends the WordFragment if the reference node could not be found (false as default).

Code samples

Example #1

{
    "wordfragments": [
        {
            "name": "wf_text",
            "actions": [
                {
                    "action": "addText",
                    "data": {
                        "text": "New text.",
                        "optionsParagraph": {
                            "fontSize": 20,
                            "color": "#0000ff"
                        }
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
                "optionsParagraph": {
                    "bold": true,
                    "font": "Arial"
                }
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.",
                "optionsParagraph": {
                    "bold": true,
                    "font": "Arial"
                }
            }
        },
        {
            "action": "replaceWordContent",
            "data": {
                "wordfragment": "wf_text",
                "referenceNode": {
                    "type": "paragraph",
                    "contains": "Lorem"
                }
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.