JavaScript API: getTemplateSymbols

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

getTemplateSymbols

PREMIUM

TRIAL / ADVANCED

Gets template symbols.

Note

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

Description

getTemplateSymbols (): [string, string]

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

These symbols can be changed by custom ones using setTemplateSymbols.

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 => {
    // get template symbols
    let templateSymbols = docx.getTemplateSymbols();
    console.log(templateSymbols);

    // set a custom template symbol
    docx.setTemplateSymbols("${", "}");

    // get template symbols
    templateSymbols = docx.getTemplateSymbols();
    console.log(templateSymbols);
});

Release notes

phpdocx 15.0:
- new method.