JSON API - modifyPageLayout

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

modifyPageLayout

PREMIUM

TRIAL / ADVANCED

Modifies the Word document layout.

Note

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

JSON data

{
    "paperType": "string"
    "options": {
        "height": number,
        "width": number,
        "marginTop": number,
        "marginRight": number,
        "marginBottom": number,
        "marginLeft": number,
        "marginHeader": number,
        "marginFooter": number,
        "numberCols": number,
        "orient": "string",
        "gutter": number,
        "vAlign": "string",
        "bidi": boolean,
        "rtl": boolean,
        "excludeHeadersAndFooters": boolean,
        "pageNumberType": {
            "fmt": "string",
            "start": number
        },
        "columns": [
            {
                "width": number,
                "space": number
            }
        ],
        "endnotes": {
            "numFmt": "string",
            "numRestart": "string",
            "numStart": number,
            "pos": "string"
        },
        "footnotes": {
            "numFmt": "string",
            "numRestart": "string",
            "numStart": number,
            "pos": "string"
        }
    }
}

Key	Description
paperType	"A4" "A3" "letter" "legal" "A4-landscape" "A3-landscape" "letter-landscape" "legal-landscape" "custom"
height	Section height in twips.
width	Section width in twips (twentieths of a point).
marginTop	Top margin for this section in twips.
marginRight	Right margin for this section in twips.
marginBottom	Bottom margin for this section in twips.
marginLeft	Left margin for this section in twips.
marginHeader	Header margin in twips.
marginFooter	Footer margin in twips.
numberCols	Number of columns for this section.
orient	Section page orientation (portrait or landscape).
gutter	Gutter in twips (used for binding).
vAlign	Vertical alignment (top, center, both, bottom)
bidi	Set to true for right to left languages. Default as false.
rtl	Set to true for right to left languages. Default as false.
excludeHeadersAndFooters	If true, exclude headers and footers reference tags. Default as false.
pageNumberType	fmt => number format (cardinalText, decimal, decimalEnclosedCircle, decimalEnclosedFullstop, decimalEnclosedParen, decimalZero, lowerLetter, lowerRoman, none, ordinalText, upperLetter, upperRoman) start => page number
columns	width space
endnotes	numFmt => numbering format: decimal, upperRoman, lowerRoman, upperLetter... numRestart => continuous, eachSect, eachPage numStart => starting value pos => sectEnd, docEnd
footnotes	numFmt => numbering format: decimal, upperRoman, lowerRoman, upperLetter... numRestart => continuous, eachSect, eachPage numStart => starting value pos => sectEnd, docEnd

Code samples

Example #1

{
    "actions": [
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
            }
        },
        {
            "action": "modifyPageLayout",
            "data": {
                "paperType": "A3-landscape",
                "options": {
                    "numberCols": 3
                }
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.