JavaScript API: replaceVariableWordFragment

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

replaceVariableWordFragment

PREMIUM

TRIAL / ADVANCED

Replaces text variables with WordFragments.

Note

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

Description

replaceVariableWordFragment (variables: Map<string, WordFragment>, target: Target = "document", options: OptionsReplaceVariableWordFragment = {}): this

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

interface OptionsReplaceVariableWordFragment
    extends OptionsFirstMatch,
        OptionsReplacementType {}

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

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

Code samples

Example #1

import { CreateDocx, OptionsText, WordFragment } 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 => {
    // create a text WordFragment
    const wordFragmentText = new WordFragment();
    const text: OptionsText = {
        bold: true,
        italic: true,
        fontSize: 14,
        text: "New content.",
    };
    wordFragmentText.addText([text]);

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

    // replace variables in the document target
    docx.replaceVariableWordFragment(variablesDocument);

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

The resulting Word document looks like:

Example #2

import {
    CreateDocx,
    OptionsDateTime,
    OptionsLink,
    OptionsReplaceVariableWordFragment,
    OptionsText,
    WordFragment,
} 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 => {
    // create a link WordFragment
    const wordFragmentLink = new WordFragment();
    const optionsLink: OptionsLink = {
        link: "https://www.phpdocx.com",
        text: "phpdocx",
    };
    wordFragmentLink.addLink(optionsLink);

    // create text WordFragments
    const wordFragmentTextDocument = new WordFragment();
    const textA: OptionsText = {
        bold: true,
        italic: true,
        fontSize: 14,
        text: "new content",
    };
    const textB: OptionsText = {
        color: "0000FF",
        font: "Times New Roman",
        text: " with styles",
    };
    wordFragmentTextDocument.addText([textA, textB]);

    const wordFragmentText = new WordFragment();
    const text: OptionsText = {
        bold: true,
        italic: true,
        fontSize: 14,
        text: "new content",
    };
    wordFragmentText.addText([text]);

    // create a date WordFragment
    const dateTime: OptionsDateTime = {
        format: "M/d/yyyy",
        bold: true,
        color: "333333",
    };
    const wordFragmentDate = new WordFragment();
    wordFragmentDate.addDateTime(dateTime);

    // variables to be replaced in the document
    const variablesDocument = new Map<string, WordFragment>();
    variablesDocument.set("VARNAME", wordFragmentTextDocument);
    variablesDocument.set("OTHERVAR", wordFragmentLink);

    // replace variable options
    const optionsReplaceVariableWordFragment: OptionsReplaceVariableWordFragment =
        {
            type: "inline",
        };

    // replace variables in the document target
    docx.replaceVariableWordFragment(
        variablesDocument,
        "document",
        optionsReplaceVariableWordFragment
    );

    // variables to be replaced in the header target
    const variablesHeader = new Map<string, WordFragment>();
    variablesHeader.set("HEADERVAR", wordFragmentText);

    // replace variables in the header target
    docx.replaceVariableWordFragment(
        variablesHeader,
        "header",
        optionsReplaceVariableWordFragment
    );

    // variables to be replaced in the footer target
    const variablesFooter = new Map<string, WordFragment>();
    variablesFooter.set("FOOTERVAR", wordFragmentDate);

    // replace variables in the footer target
    docx.replaceVariableWordFragment(
        variablesFooter,
        "footer",
        optionsReplaceVariableWordFragment
    );

    // variables to be replaced in the comment target
    const variablesComment = new Map<string, WordFragment>();
    variablesComment.set("COMMENTVAR_1", wordFragmentText);

    // replace variables in the comment target
    docx.replaceVariableWordFragment(
        variablesComment,
        "comment",
        optionsReplaceVariableWordFragment
    );

    // variables to be replaced in the endnote target
    const variablesEndnote = new Map<string, WordFragment>();
    variablesEndnote.set("ENDNOTEVAR", wordFragmentText);

    // replace variables in the footer target
    docx.replaceVariableWordFragment(
        variablesEndnote,
        "endnote",
        optionsReplaceVariableWordFragment
    );

    // variables to be replaced in the footnote target
    const variablesFootnote = new Map<string, WordFragment>();
    variablesFootnote.set("FOOTNOTEVAR", wordFragmentText);

    // replace variables in the footer target
    docx.replaceVariableWordFragment(
        variablesFootnote,
        "footnote",
        optionsReplaceVariableWordFragment
    );

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

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.