JSON API - docxSettings

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

docxSettings

PREMIUM

TRIAL / ADVANCED

Modifies the general Word settings.

Note

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

JSON data

{
    "autoHyphenation": boolean
    "bookFoldPrinting": boolean,
    "bookFoldPrintingSheets": number,
    "bookFoldRevPrinting": boolean,
    "bordersDoNotSurroundFooter": boolean,
    "bordersDoNotSurroundHeader": boolean,
    "compat": object,
    "consecutiveHyphenLimit": number,
    "defaultTabStop": number,
    "defaultTableStyle": "string",
    "documentType": "string",
    "doNotHyphenateCaps": boolean,
    "doNotShadeFormData": boolean,
    "gutterAtTop": boolean,
    "hideGrammaticalErrors": boolean,
    "hideSpellingErrors": boolean,
    "hyphenationZone": number,
    "mirrorMargins": boolean,
    "noPunctuationKerning": boolean,
    "printTwoOnOne": boolean,
    "savePreviewPicture": boolean,
    "trackRevisions": boolean,
    "updateFields": boolean,
    "view": "string",
    "writeProtection": boolean,
    "zoom": number | "string",
    "customSetting": {
        "tag": "string",
        "values": object
     }
}

Key	Description
autoHyphenation
bookFoldPrinting
bookFoldPrintingSheets	Number of pages per booklet.
bookFoldRevPrinting
bordersDoNotSurroundFooter
bordersDoNotSurroundHeader
compat	Compatibility setting tags.
consecutiveHyphenLimit	Maximum number of consecutively hyphenated lines.
defaultTabStop	In twips (twentieths of a point).
defaultTableStyle	The table style to be used by default.
documentType	notSpecified (default), letter, eMail.
doNotHyphenateCaps	Do not hyphenate capital letters.
doNotShadeFormData
gutterAtTop
hideGrammaticalErrors
hideSpellingErrors
hyphenationZone	Distance in twips (twentieths of a point).
mirrorMargins	If true interchanges inside and outside margins in odd and even pages.
noPunctuationKerning	Never kern punctuation characters.
printTwoOnOne	Print two pages per sheet.
savePreviewPicture	Generate thumbnail for document on save.
trackRevisions
updateFields	Automatically recalculate fields on open.
view	none (default), print, outline, masterPages, normal (draft view), web.
writeProtection	Enable readonly.
zoom	A percentage or none, fullPage (display one full page), bestFit (display page width), textFit (display text width).
customSetting	Custom settings.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addText",
            "data": {
                "text": "In this case we set the view mode as \"outline\" and the default zoom on opening to 70%."
            }
        },
        {
            "action": "docxSettings",
            "data": {
                "view": "outline",
                "zoom": 70
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.