addIndex

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

addIndex

ADVANCED / PREMIUM

TRIAL

Inserts an Index into the Word document.

Description

public addIndex ( [array $options [, array $legend]] )

This method allows to include an Index in the Word document.

Parameters

options

The possible keys and values are:

Key	Type	Description
autoUpdate	boolean	If true it will try to update the content when first opened.
columns	int	Default as 2.
langCode	string	Default as 1033 (English - United States).
style	string	Custom paragraph style to be applied.
type	string	indented (default) run-in

legend

The possible keys and values are:

Key	Type	Description
text	array	The placeholder text that will be shown if the autoupdate option is not activated.
		Styles from addText.

Exceptions

Method not available.

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.