JSON API - getDocxPathQueryInfo

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

getDocxPathQueryInfo

PREMIUM

TRIAL / ADVANCED

Gets information from a performed DOCXPath query.

Note

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

JSON data

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

Key	Description
referenceNode	Reference node cloned.
type	* (all, default value) bookmark 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 tracking-insert tracking-delete tracking-run-style tracking-paragraph-style tracking-table-style tracking-table-grid tracking-table-row
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.

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": "getDocxPathQueryInfo",
            "data": {
                "referenceNode": {
                    "type": "paragraph"
                }
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.