JavaScript API: setTemplateSymbols

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

setTemplateSymbols

PREMIUM

TRIAL / ADVANCED

Sets template symbols.

Note

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

Description

setTemplateSymbols (templateSymbolStart: string, templateSymbolEnd?: string): this

By default phpdocx template variables have to be wrapped by dollar symbols ($).

The character or symbol used to wrap template variables may be:

The same at the beginning and the end: $VAR$, |VAR|, #VAR#...
Different at the beginning and the end: ${VAR}, #{VAR}, [[VAR]], «VAR»...

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 => {
    // set a custom template symbol
    docx.setTemplateSymbols("${", "}");

    // variables to be replaced
    const variables = new Map<string, string>();
    variables.set("VAR", "New value");

    // replace variables
    docx.replaceVariableText(variables);

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

Release notes

phpdocx 15.0:
- new method.