JavaScript API: docxSettings

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

docxSettings

PREMIUM

TRIAL / ADVANCED

Sets docx settings.

Note

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

Description

docxSettings (settings: OptionsSettings): this

interface OptionsSettings {
    /** Do not show visual indicator for form fields */
    doNotShadeFormData?: boolean;
    /** Different even/odd page headers and footers */
    evenAndOddHeaders?: boolean;
    /** Do not display visual indication of grammatical errors */
    hideGrammaticalErrors?: boolean;
    /** Do not display visual indication of spelling errors */
    hideSpellingErrors?: boolean;
    /** Automatically recalculate fields on open */
    updateFields?: boolean;
    /** Document view setting */
    view?: "none" | "print" | "outline" | "masterPages" | "normal" | "web";
    /** Magnification setting */
    zoom?: number | ("none" | "fullPage" | "bestFit" | "textFit");
}

Code samples

Example #1

import { CreateDocx, OptionsSettings } from "build";
import * as fs from "fs";

const docx = new CreateDocx();

const docxSettings: OptionsSettings = {
    hideGrammaticalErrors: true,
    hideSpellingErrors: true,
};
docx.docxSettings(docxSettings);

docx.save().then(contents => {
    fs.writeFileSync("docxSettings_1.docx", Buffer.from(contents));
});

Release notes

phpdocx 15.0:
- new method.