JSON API - addBookmark

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addBookmark

PREMIUM

TRIAL / ADVANCED

Inserts a bookmark.

Note

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

JSON data

{
    "name": "string",
    "type": "string"
}

Key	Description
name	The name that you want to give to the corresponding bookmark. This is the parameter that should be used within the addLink method to link to the bookmarked content.
type	The bookmark type. Possible values are "start" and "end".

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"
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.