JavaScript API: replaceVariableCheckbox

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

replaceVariableCheckbox

PREMIUM

TRIAL / ADVANCED

Checks or unchecks template checkboxes.

Note

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

Description

replaceVariableCheckbox (variables: Map<string, boolean>, options: OptionsReplaceVariableCheckbox = {}): this

interface OptionsReplaceVariableCheckbox extends OptionsFirstMatch {}

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

Code samples

Example #1

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

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

const docx = new CreateDocx();
// load the template
docx.openTemplate(docxTemplate).then(docx => {
    // variables to be replaced
    const variablesDocument = new Map<string, boolean>();
    variablesDocument.set("check1", true);
    variablesDocument.set("check2", false);
    variablesDocument.set("check3", true);

    // replace variables
    docx.replaceVariableCheckbox(variablesDocument);

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

The resulting Word document looks like:

Release notes

phpdocx 15.5:
- new method.