JavaScript API: addStructuredDocumentTag

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addStructuredDocumentTag

PREMIUM

TRIAL / ADVANCED

Adds structured document tag.

Note

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

Description

addStructuredDocumentTag (type: StructuredDocumentTagType, options: OptionsStructuredDocumentTag, optionsParagraph: OptionsParagraph = {}): this

type StructuredDocumentTagType =
    | "checkbox"
    | "comboBox"
    | "date"
    | "dropDownList"
    | "richText";

interface OptionsStructuredDocumentTag extends OptionsRpr {
    /** Label */
    alias?: string;
    /** Calendar. Default as gregorian */
    calendar?: string;
    /** Checked. Default as false */
    checked?: boolean;
    /** Checked state */
    checkedState?: {
        /** Font family. Default as MS Gothic */
        font?: string;
        /** Default as 2612 */
        value?: string;
    };
    /** Date format. Default as M/d/yyyy */
    dateFormat?: string;
    /** List items */
    listItems?: Map<string, string>;
    /** Local. Default as en-US */
    local?: string;
    /** Locking properties. Default as unlocked */
    lock?: "contentLocked" | "sdtContentLocked" | "sdtLocked" | "unlocked";
    /** Text to be shown by default */
    placeholderText?: string;
    /** Symbol used for checkbox */
    sym?: {
        /** Chart */
        char?: string;
        /** Font family */
        font?: string;
    };
    /** A programmatic tag */
    tag?: string;
    /** If true the structured tag is removed after editing */
    temporary?: boolean;
    /** Unchecked state */
    uncheckedState?: {
        /** Font family. Default as MS Gothic */
        font?: string;
        /** Default as 2610 */
        value?: string;
    };
}

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, OptionsStructuredDocumentTag } from "build";
import * as fs from "fs";

const docx = new CreateDocx();

// combo box
let items = new Map<string, string>();
items.set("First Choice", "1");
items.set("Second Choice", "2");
items.set("Third Choice", "3");
let optionsStructuredDocumentTag: OptionsStructuredDocumentTag = {
    alias: "Combo Box",
    bold: true,
    color: "FF0000",
    font: "Algerian",
    fontSize: 12,
    italic: true,
    listItems: items,
    placeholderText: "Choose a value",
    underline: "single",
};
docx.addStructuredDocumentTag("comboBox", optionsStructuredDocumentTag);

// date
optionsStructuredDocumentTag = {
    alias: "Date picker",
    bold: true,
    color: "777777",
    font: "Calibri",
    fontSize: 14,
    italic: true,
    placeholderText: "Choose a date",
};
docx.addStructuredDocumentTag("date", optionsStructuredDocumentTag);

// dropdown
items = new Map<string, string>();
items.set("One", "1");
items.set("Two", "2");
items.set("Three", "3");
optionsStructuredDocumentTag = {
    alias: "Dropdown menu",
    fontSize: 12,
    listItems: items,
    placeholderText: "Choose a value",
};
docx.addStructuredDocumentTag("comboBox", optionsStructuredDocumentTag);

// richText
optionsStructuredDocumentTag = {
    alias: "Rich text",
    lock: "contentLocked",
    placeholderText: "This text is locked",
};
docx.addStructuredDocumentTag("richText", optionsStructuredDocumentTag);

// checkboxes with custom styles
optionsStructuredDocumentTag = {
    checked: true,
    fontSize: 18,
};
docx.addStructuredDocumentTag("checkbox", optionsStructuredDocumentTag);
optionsStructuredDocumentTag = {
    checked: true,
    fontSize: 18,
    highlight: "red",
};
docx.addStructuredDocumentTag("checkbox", optionsStructuredDocumentTag);
// checkbox with custom styles and custom symbol
optionsStructuredDocumentTag = {
    checked: true,
    checkedState: {
        font: "Wingdings",
        value: "00FE",
    },
    fontSize: 18,
    sym: {
        char: "00FE",
        font: "Wingdings",
    },
    uncheckedState: {
        font: "Wingdings",
        value: "006F",
    },
};
docx.addStructuredDocumentTag("checkbox", optionsStructuredDocumentTag);

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

The resulting Word document looks like:

Release notes

phpdocx 15.5:
- new method.