XML API - pdx:addBookmark

pdx:addBookmark

Inserts a bookmark into a Word document.

Note

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

Description

Element definition

This element allows to insert bookmarks into a Word document.

This method should be called at least twice: one to open the bookmark tag (type start) and the other one to close it (type end).

One may link the generated bookmark with the addLink element to facilitate the internal navigation through the Word document contents.

Attributes and sub-elements

options

Key Description
type The bookmark type. Possible values are 'start' and 'end'
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
Code samples

Example #1

config.xml

content.xml

settings.xml

PHP code

The resulting Word document looks like: