JSON API - addLineNumbering

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addLineNumbering

PREMIUM

TRIAL / ADVANCED

Includes line numbering into the Word document.

Note

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

JSON data

{
    "countBy": number,
    "start": number,
    "distance": number,
    "restart": "string"
}

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

{
    "actions": [
        {
            "action": "addLineNumbering"
        },
        {
            "action": "addText",
            "data": {
                "text": "This is just a chunk of text that we will repeat couple of times to fill up some space. This is just a chunk of text that we will repeat couple of times to fill up some space."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Another chunk of text "
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This is just a chunk of text that we will repeat couple of times to fill up some space. This is just a chunk of text that we will repeat couple of times to fill up some space."
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.