JavaScript API: replaceVariableExternalFile

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

replaceVariableExternalFile

PREMIUM

TRIAL / ADVANCED

Replaces text variables with external files.

Note

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

Description

replaceVariableExternalFile (variables: Map<string, WordFragment>, options: OptionsReplaceVariableExternalFile = {}): this

Only compatible with MS Word 2007 or newer.

interface OptionsReplaceVariableExternalFile extends OptionsFirstMatch {}

interface OptionsFirstMatch {
    /** Replace only the first match. Default as false */
    firstMatch?: boolean;
}

Code samples

Example #1

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

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

const docx = new CreateDocx();
// load the template
docx.openTemplate(docxTemplate).then(docx => {
    const fileDocx = fs.readFileSync("file.docx");
    const fileHtml = fs.readFileSync("file.html");

    const externalFileDocxWordFragment = new WordFragment();
    const externalFileDocx: OptionsAltchunk = {
        file: fileDocx,
        type: "docx",
    };
    externalFileDocxWordFragment.addExternalFile(externalFileDocx);

    const externalFileHtmlWordFragment = new WordFragment();
    const externalFileHtml: OptionsAltchunk = {
        file: fileHtml,
        type: "html",
    };
    externalFileHtmlWordFragment.addExternalFile(externalFileHtml);

    // variables to be replaced
    const variablesDocument = new Map<string, WordFragment>();
    variablesDocument.set("VARNAME", externalFileDocxWordFragment);
    variablesDocument.set("OTHERVAR", externalFileHtmlWordFragment);

    // replace variables
    const optionsReplaceVariableExternalFile: OptionsReplaceVariableExternalFile =
        {
            firstMatch: true,
        };
    docx.replaceVariableExternalFile(
        variablesDocument,
        optionsReplaceVariableExternalFile
    );

    // save the DOCX
    docx.save().then(contents => {
        fs.writeFileSync(
            "replaceVariableExternalFile_1.docx",
            Buffer.from(contents)
        );
    });
});

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.