JavaScript API: removeVariableText

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

removeVariableText

PREMIUM

TRIAL / ADVANCED

Removes text variables.

Note

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

Description

removeVariableText (variables: string[], target: Target = "document", options: OptionsRemoveVariableText = {}): this

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

interface OptionsRemoveVariableText
    extends OptionsFirstMatch,
        OptionsReplacementType {}

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

interface OptionsReplacementType {
    /** Remove type: inline, block. Default as inline  */
    type?: "inline" | "block";
}

Code samples

Example #1

import { CreateDocx, OptionsRemoveVariableText } 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 removed in the document target
    const variablesDocument = ["VARNAME", "OTHERVAR"];
    // remove template variables in the document target
    docx.removeVariableText(variablesDocument);

    // variables to be removed in the header target
    const variablesHeader = ["HEADERVAR"];
    // remove template variables in the header target
    docx.removeVariableText(variablesHeader, "header");

    // variables to be removed in the footer target
    const variablesFooter = ["FOOTERVAR"];
    // remove template variables in the footer target using a block type removal
    const optionsRemoveVariable: OptionsRemoveVariableText = {
        type: "block",
    };
    docx.removeVariableText(variablesFooter, "footer", optionsRemoveVariable);

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

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.