JSON API - addCrossReference

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addCrossReference

PREMIUM

TRIAL / ADVANCED

Inserts a cross-reference.

Note

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

JSON data

{
    "text": "string",
    "options": {
        "type": "string",
        "modifiers": "string",
        "referenceName": "string",
        "referenceTo": "string",
        /* check addText styles */
    }
}

Styles from addText can be used.

Key	Description
text	Text content.
type	The bookmark type. Possible values are 'bookmark' and 'heading'.
modifiers	Custom modifiers: \r \h, \n \h....
referenceName	The name of the element to be referred.
referenceTo	Content to display when the field is updated PAGEREF (default, page number), REF (bookmark text content), ABOVE_BELOW (above/below text).

Code samples

Example #1

{
    "actions": [
        {
            "action": "addBookmark",
            "data": { "type": "start", "name": "bookmark_name" }
        },
        {
            "action": "addText",
            "data": {
                "text": "Text that has been bookmarked."
            }
        },
        {
            "action": "addBookmark",
            "data": {
                "type": "end",
                "name": "bookmark_name"
            }
        },
        {
            "action": "addBreak",
            "data": {
                "type": "page"
            }
        },
        {
            "action": "addCrossReference",
            "data": {
                "text": "Page-1",
                "options": {
                    "type": "bookmark",
                    "referenceName": "bookmark_name"
                }
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.