JavaScript API: replaceVariableWordMl

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

replaceVariableWordMl

PREMIUM

TRIAL / ADVANCED

Replaces text variables with WordML.

Note

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

Description

replaceVariableWordMl (variables: Map, target: Target = "document", options: OptionsReplaceVariableWordMl = {}): this

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

interface OptionsReplaceVariableWordMl extends OptionsFirstMatch {}

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

Code samples

Example #1

import { CreateDocx, 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 wordMlFragment = new WordFragment();
    wordMlFragment.addWordMl(
        '<w:p><w:r><w:t xml:space="preserve">This is a simple paragraph with some </w:t></w:r><w:r><w:rPr><w:b/></w:rPr><w:t>bold</w:t></w:r><w:r><w:t xml:space="preserve"> text.</w:t></w:r></w:p>'
    );

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

    docx.replaceVariableWordMl(variablesDocument);

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

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.