addLineNumbering

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

addLineNumbering

TRIAL / ADVANCED / PREMIUM

Includes line numbering into the Word document.

Description

public addLineNumbering ( array $options )

This method allows the insertion of line numbers in the current Word document. It allows a full customization including:

The line number increments to display: if set to one (default value) all lines are numbered, if set, for example to five only each fifth line will be numbered and the numbers will jump accordingly (5, 10, 15...).
The start number: it is one by default.
The distance between the line numbers and the corresponding paragraphs.
The restarting conditions: one may choose if the numbering is continuous (default behaviour) or if it should be restarted in each new document page or section.

Parameters

options

This is an array including all the available styling options.

Key	Type	Description
countBy	int	An integer indicating the line number increments to display. If left empty is set to 1.
start	int	An integer indicating which number must be associated with the first line. The default value is 1.
distance	int	An integer indicating the distance, in twentieths of a point, between the number and the associated line. If left empty is dealt automatically by Word.
restart	string	A string that can take the following values: continuous: default value, the numbering does not get restarted anywhere in the document. newPage: the numbering restarts at the beginning of every page. newSection: the numbering restarts at the beginning of every section.

Code samples

Example #1:

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$docx->addLineNumbering();

$text = 'This is just a chunk of text that we will repeat couple of times to fill up some space. ';
$text .= $text;
$docx->addText($text);
$docx->addText('Another chunk of text');
$docx->addText($text);

$docx->createDocx('output');

The resulting Word document looks like: