JSON API - cloneWordContent

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

cloneWordContent

PREMIUM

TRIAL / ADVANCED

Clones contents in the document.

Note

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

JSON data

{
    "referenceToBeCloned": {
        "type": "string",
        "contains": "string",
        "occurrence": number | "string" | array,
        "attributes": array,
        "parent": "string",
        "customQuery": "string"
    },
    "referenceNodeTo": {
        "type": "string",
        "contains": "string",
        "occurrence": number | "string" | array,
        "attributes": array,
        "parent": "string",
        "customQuery": "string"
    },
    "location": "string",
    "forceAppend": boolean
}

Key	Description
referenceToBeCloned	Reference node to be cloned.
referenceNodeTo	Destination reference node.
type	* (all, default value) break chart endnote (content reference) footnote (content reference) image list 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/...).
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

{
    "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": "addText",
            "data": {
                "text": "Donec blandit ex nec lectus iaculis imperdiet. Donec a dictum odio. Morbi viverra, urna eu consectetur tincidunt, ex urna commodo turpis, ut euismod diam augue ac tellus.",
                "optionsParagraph": {
                    "bold": true,
                    "font": "Arial"
                }
            }
        },
        {
            "action": "cloneWordContent",
            "data": {
                "referenceToBeCloned": {
                    "type": "paragraph",
                    "contains": "Donec"
                },
                "referenceNodeTo": {
                    "type": "paragraph",
                    "contains": "Lorem"
                },
                "location": "after"
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.