JavaScript API: addExternalFile

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addExternalFile

PREMIUM

TRIAL / ADVANCED

Adds external file.

Note

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

Description

addExternalFile (options: OptionsAltchunk): this

Only compatible with MS Word 2007 or newer.

interface OptionsAltchunk {
    /** File content */
    file: ArrayBuffer;
    /** File type */
    type: "docx" | "html" | "mht" | "rtf";
}

Code samples

Example #1

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

const docx = new CreateDocx();

const fileDocx = fs.readFileSync("document.docx");

docx.addText(
    "Insert a DOCX file (this method is not supported by all DOCX readers):"
);

const externalFile: OptionsAltchunk = {
    file: fileDocx,
    type: "docx",
};
docx.addExternalFile(externalFile);

docx.addText("A new paragraph");

docx.addExternalFile(externalFile);

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

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.