XmlApi - pdx:setLineNumbering


Inserts line numbering into an already existing Word document.


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


Element definition

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


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




PHP code

The resulting Word document looks like: