setLineNumbering

LAYOUT & GENERAL
WORD CONTENT
TEMPLATES
FORMAT CONVERSION
DOCXPATH
DOCXUTILITIES
DOCXPATHUTILITIES
PDFUTILITIES
DOCXCUSTOMIZER
PERFORMANCE
ENCRYPT

setLineNumbering

ADVANCED / PREMIUM BASIC

Inserts line numbering into an already existing Word document.

Description
public void setLineNumbering(String source, String target) throws Exception
public void setLineNumbering(String source, String target, Integer countBy) throws Exception
public void setLineNumbering(String source, String target, Integer countBy, Integer start) throws Exception
public void setLineNumbering(String source, String target, Integer countBy, Integer start, Integer distance) throws Exception
public void setLineNumbering(String source, String target, Integer countBy, Integer start, Integer distance, String restart) throws Exception

This method allows to insert or modify the 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.

Parameters

source

The path to the source Word document.

target

The path to the resulting Word document.

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

"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

The resulting Word document looks like: