XML API - pdx:addBookmark

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

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

<pdx:content>
    <pdx:addBookmark pdx:type="start|end" pdx:name="" pdx:wordFragmentName="" />
</pdx:content>

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

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:config>
        <pdx:output pdx:name="output" pdx:type="docx" />
    </pdx:config>
</pdx:document>

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:content>
        <pdx:addBookmark pdx:type="start" pdx:name="bookmark_name" />
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Text that has been bookmarked.</pdx:data>
                <pdx:textRunStyle>
                    <pdx:font pdx:value="Arial" />
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addBookmark pdx:type="end" pdx:name="bookmark_name" />
    </pdx:content>
</pdx:document>

settings.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:settings>
    </pdx:settings>
</pdx:document>

PHP code

require_once 'path_to_phpdocx/classes/CreateDocx.php';

$docx = new XMLAPI('config.xml');
$docx->setDocumentProperties('settings.xml');
$docx->addContent('content.xml');

$docx->render();

The resulting Word document looks like: