JavaScript API: openTemplate

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

openTemplate

PREMIUM

TRIAL / ADVANCED

Opens a DOCX template.

Note

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

Description

openTemplate (template: ArrayBuffer, options: OptionsTemplate = {}): Promise<this>

interface OptionsTemplate {
    /** Import default MS Word styles. Default as true */
    importMSWordDefaultStyles?: boolean;
}

Errors

Error reading DOCX contents.

Code samples

Example #1

const docxBaseTemplate = fs.readFileSync("template.docx");

const docx = new CreateDocx();
docx.openTemplate(docxBaseTemplate).then(docx => {
    docx.save().then(contents => {
        fs.writeFileSync("openTemplate_1.docx", Buffer.from(contents));
    });
});

Release notes

phpdocx 15.5:
- Get existing bookmark and numbering IDs when opening a template to avoid duplicated values in new contents.
- DOCM, DOTX and DOTM files as templates.

phpdocx 15.0:
- new method.