XML API - pdx:addLineNumbering

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addLineNumbering

Includes line numbering into the Word document.

Note

You are reading the XML API documentation. For the PHP API method please go to addLineNumbering.

Description

Element definition

<pdx:settings>
    <pdx:addLineNumbering pdx:countBy="" pdx:start="" pdx:distance="" pdx:restart="" />
</pdx:settings>

This element allows the insertion of line numbers in the current Word document. It allows 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.

Attributes and sub-elements

options

Key	Description
countBy	An integer indicating the line number increments to display. If left empty is set to 1.
start	An integer indicating which number must be associated with the first line. The default value is 1.
distance	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	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

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:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">This is just a chunk of text repeated a couple of times to fill up some space. This is just a chunk of text repeated a couple of times to fill up some space.</pdx:data>
                <pdx:textRunStyle>
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Another chunk of text</pdx:data>
                <pdx:textRunStyle>
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
    </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:addLineNumbering pdx:countBy="1" pdx:start="1" pdx:distance="1" pdx:restart="1" />
    </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: