markEntry

WORD CONTENTS

LAYOUT & SETTINGS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

markEntry

ADVANCED / PREMIUM

TRIAL

Marks an index entry into the Word document.

Description

public markEntry ( [array $options [, array $styles]] )

This method allows to mark an index entry in the Word document.

This method must be used as WordFragment.

Parameters

options

The possible keys and values are:

Key	Type	Description
mainEntry	string	Default as "Entry".
subEntry	string
type	string	cross-reference current-page (default) page-range
seeText	string	Used in cross-reference entries. Default as 'See'.
bookmark	string	Required in page-range entries.

$styles

rPr styles. See createCharacterStyle.

Exceptions

Method not available.

Not used as WordFragment.

bookmark required for page-range entries.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$docx->addIndex(array('autoUpdate' => true));

$docx->addText('A text content.');

$markEntryFragment = new WordFragment($docx);
$markEntryFragment->markEntry(array('mainEntry' => 'Text entry.', 'subEntry' => 'with a subentry'));

$text = array();

$text[] = array(
    'text' => 'A marked index entry',
);
$text[] = $markEntryFragment;
$text[] = array(
    'text' => ' and more content.',
);

$docx->addText($text);

$docx->createDocx('output');

Release notes

phpdocx 17.0:
- new method.