XML API - pdx:setLineNumbering

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:setLineNumbering

Inserts line numbering into an already existing Word document.

Note

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

Description

Element definition

<pdx:utilities>
    <pdx:setLineNumbering pdx:countBy="" pdx:start="" pdx:distance="" pdx:restart="continuous|newPage|newSection" />
</pdx:utilities>

This method allows the insertion or modification of line numbering properties of an existing Word document in .docx format.

The available options include:

Line number increments to display.
Start number.
Distance between line numbers and text.
Restarting conditions: continuous or restarted in each new document page or section.

Attributes and sub-elements

options

This is an array including all the available styling options. The possible keys and values of this array are:

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:utilities>
        <pdx:setLineNumbering pdx:source="/var/www/phpdocx/samples/files/second.docx" pdx:target="/var/www/phpdocx/samples/DocxUtilities/setLineNumbering/output_setLineNumbering.docx" pdx:start="25" />
    </pdx:utilities>
</pdx:document>

settings.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:settings>
    </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: