JavaScript API: addMergeField

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addMergeField

PREMIUM

TRIAL / ADVANCED

Adds merge field.

Note

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

Description

addMergeField (name: string, options: OptionsMergeField = {}, optionsParagraph: OptionsParagraph = {}): this

interface OptionsMergeField extends OptionsRpr {
    /** Mapped field */
    mappedField?: boolean;
    /** Preserve format. Default as true */
    preserveFormat?: boolean;
    /** Text to include after the merge field */
    textAfter?: string;
    /** Text to include before the merge field */
    textBefore?: string;
    /** Vertical format */
    verticalFormat?: boolean;
}

interface OptionsParagraph extends OptionsRpr {
    /** Alignment */
    align?: string;
    /** Background color: HEX value */
    backgroundColor?: string;
    /** Bidi */
    bidi?: boolean;
    /** Contextual spacing. Don't added space between paragraphs of the same style */
    contextualSpacing?: boolean;
    /** Indentations: twips value */
    indentation?: {
        firstLine?: number;
        hanging?: number;
        left?: number;
        right?: number;
    };
    /** Keep lines together */
    keepLines?: boolean;
    /** Keep with next */
    keepNext?: boolean;
    /** Spacing: twips value */
    spacing?: {
        line?: number;
        after?: number;
        before?: number;
    };
    /** Outline level (heading level): 1, 2, 3... */
    outlineLvl?: number;
    /** Paragraph style */
    pStyle?: string;
    /** Parse line breaks. Default as true */
    parseLineBreaks?: boolean;
    /** Parse tabs. Default as true */
    parseTabs?: boolean;
    /** Parse break before */
    pageBreakBefore?: boolean;
    /** RTL */
    rtl?: boolean;
    /** Shading color: HEX value */
    shading?: string;
    /** Text direction */
    textDirection?: "lrTb" | "tbRl" | "btLr" | "lrTbV" | "tbRlV" | "tbLrV";
    /** Widow control */
    widowControl?: boolean;
    /** Word wrap */
    wordWrap?: boolean;
}

interface OptionsRpr {
    /** Bold */
    bold?: boolean;
    /** Capital letters */
    caps?: boolean;
    /** Character spacing: twips value */
    characterSpacing?: number;
    /** Color: HEX value */
    color?: string;
    /** Em */
    em?: "circle" | "comma" | "dot" | "none" | "underDot";
    /** Emboss */
    emboss?: boolean;
    /** Font family */
    font?: string;
    /** Font size: point values */
    fontSize?: number;
    /** Highligh color */
    highlight?:
        | "black"
        | "blue"
        | "cyan"
        | "green"
        | "magenta"
        | "red"
        | "yellow"
        | "white"
        | "darkBlue"
        | "darkCyan"
        | "darkGreen"
        | "darkMagenta"
        | "darkRed"
        | "darkYellow"
        | "darkGray"
        | "lightGray"
        | "none";
    /** Italic */
    italic?: boolean;
    /** Language */
    lang?: string;
    /** Do not check spelling or grammar */
    noProof?: boolean;
    /** Vertically raised or lowered text: half-points value */
    position?: number;
    /** Character style */
    rStyle?: string;
    /** Shadow */
    shadow?: boolean;
    /** Small caps */
    smallCaps?: boolean;
    /** Strikethrough */
    strikethrough?: boolean;
    /** Underline */
    underline?:
        | "single"
        | "words"
        | "double"
        | "thic"
        | "dotted"
        | "dottedHeavy"
        | "dash"
        | "dashedHeavy"
        | "dashLong"
        | "dashLongHeavy"
        | "dotDash"
        | "dashDotHeavy"
        | "dotDotDash"
        | "dashDotDotHeavy"
        | "wave"
        | "wavyHeavy"
        | "wavyDouble"
        | "none";
    /** Underline color: HEX value */
    underlineColor?: string;
    /** Hidden text */
    vanish?: boolean;
    /** Vertical position */
    verticalAlign?: "baseline" | "superscript" | "subscript";
}

Code samples

Example #1

import {
    CreateDocx,
    OptionsMergeField,
    OptionsParagraph,
} from "build";
import * as fs from "fs";

const docx = new CreateDocx();

// add a merge field
docx.addMergeField("MyMergeField example");

// add a merge field applying styles
const optionsMergeField: OptionsMergeField = {
    bold: true,
    color: "B70000",
    textBefore: "A mergefield example: ",
    textAfter: " and some text afterwards.",
    verticalFormat: true,
};
const optionsParagraph: OptionsParagraph = {
    align: "center",
    pStyle: "Heading2",
};
docx.addMergeField(
    "MyMergeField with styles",
    optionsMergeField,
    optionsParagraph
);

docx.save().then(contents => {
    fs.writeFileSync("addMergeField_1.docx", Buffer.from(contents));
});

The resulting Word document looks like:

Release notes

phpdocx 15.5:
- new method.