addBookmark

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

addBookmark

TRIAL / ADVANCED / PREMIUM

Inserts a bookmark into a Word document.

Description

public addBookmark ( array $options )

This method allows to insert bookmarks into a Word document.

This method should be called at least twice within a PHP script: 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 method to facilitate the internal navigation through the Word document contents.

Parameters

options

The options array includes the following keys and values (required options are shown with yellow background):

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

Exceptions

Lack of required parameters.

Missing start bookmark.

Incorrect type.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$docx->addBookmark(array('type' => 'start', 'name' => 'bookmark_name'));
$docx->addText('Text that has been bookmarked.');
$docx->addBookmark(array('type' => 'end', 'name' => 'bookmark_name'));

$docx->createDocx('output');

Example #2

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$bookmarkStart = new WordFragment($docx);
$bookmarkStart->addBookmark(array('type' => 'start', 'name' => 'bookmark_name'));
$bookmarkEnd = new WordFragment($docx);
$bookmarkEnd->addBookmark(array('type' => 'end', 'name' => 'bookmark_name'));

$textRuns = array();
$textRuns[] = array('text' => 'We are only going to bookmark: ');
$textRuns[] = $bookmarkStart;
$textRuns[] = array('text' => 'this words.');
$textRuns[] = $bookmarkEnd;

$docx->addText($textRuns);

$docx->createDocx('output');

The resulting Word document looks like: