JavaScript API: replaceVariableInputField

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

replaceVariableInputField

PREMIUM

TRIAL / ADVANCED

Replaces input field variable values.

Note

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

Description

replaceVariableInputField (variables: Map<string, string>, target: Target = "document"): this

type Target =
    | "document"
    | "header"
    | "footer"
    | "comment"
    | "endnote"
    | "footnote";

Code samples

Example #1

import { CreateDocx } 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 => {
    // variables to be replaced
    const variablesDocument = new Map<string, string>();
    variablesDocument.set("textfield_1", "first");
    variablesDocument.set("textfield_2", "second");
    variablesDocument.set("sdt_1", "third");
    variablesDocument.set("sdt_2", "fourth");

    // replace variables
    docx.replaceVariableInputField(variablesDocument);

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

The resulting Word document looks like:

Release notes

phpdocx 15.5:
- new method.