JSON API - addPageNumber

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addPageNumber

PREMIUM

TRIAL / ADVANCED

Inserts the current page number.

Note

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

JSON data

{
    "type": "string",
    "options": {
        /* check addText styles */
    }
}

Styles from addText can be used.

Key	Description
type	"numerical" (default), "alphabetical" or "page-of".

options for page-of type:

Key	Description
pStyle	Paragraph style to be used.
textAlign	center, left or right.

Code samples

Example #1

{
    "wordfragments": [
        {
            "name": "wf_numbering",
            "target": "defaultHeader",
            "actions": [
                {
                    "action": "addPageNumber",
                    "data": {
                        "type": "numerical",
                        "options": {
                            "textAlign": "right",
                            "bold": true,
                            "fontSize": 14,
                            "color": "B70000"
                        }
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addHeader",
            "data": {
                "default": "wf_numbering"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This is the first page."
            }
        },
        {
            "action": "addBreak",
            "data": {
                "type": "page"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This is the second page."
            }
        },
        {
            "action": "addBreak",
            "data": {
                "type": "page"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This is the third page."
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.