JavaScript API: addTextBox

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addTextBox

PREMIUM

TRIAL / ADVANCED

Adds text box.

Note

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

Description

addTextBox (content: string | (Element.OptionsText | WordFragment)[], options: Element.OptionsTextBox = {}): this

interface OptionsTextBox {
    /** Align. Default as left */
    align?: "absolute" | "center" | "inline" | "left" | "right";
    /** Border */
    border?: {
        /** HEX value */
        color?: string;
        /** Disable border */
        disable?: boolean;
        /** Point value */
        width?: number;
    };
    /** Content vertical align */
    contentVerticalAlign?: "bottom" | "center" | "top";
    /** Dash style: "longDashDot", "1 1", "3 1"... */
    dashStyle?: string;
    /** Direction */
    direction?: "ltr" | "rtl";
    /** Fill color: HEX value */
    fillColor?: string;
    /** Height: point value. Default as auto */
    height?: number | "auto";
    /** Line style: single, thinThin, thinThick, thickThin, thickBetweenThin... */
    lineStyle?: string;
    /** Margins: cm value */
    margin?: {
        top?: number;
        right?: number;
        bottom?: number;
        left?: number;
    };
    /** Paddings: mm value */
    padding?: {
        /** Default as 1.3 */
        top?: number;
        /** Default as 2.5 */
        right?: number;
        /** Default as 1.3 */
        bottom?: number;
        /** Default as 2.5 */
        left?: number;
    };
    /** Position */
    position?: "absolute";
    /** Relative to horizontal */
    relativeToHorizontal?: "char" | "margin" | "page" | "text";
    /** Relative to vertical */
    relativeToVertical?: "line" | "margin" | "page" | "text";
    /** Extra textbox styles. Default as "mso-fit-shape-to-text:t;" if height is auto */
    textboxStyle?: string;
    /** Text wrap. Default as square */
    textWrap?: "tight" | "square" | "through";
    /** Width: point value. Default as 180 */
    width?: number;
    /** Z-index */
    zIndex?: number;
}

Code samples

Example #1

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

const docx = new CreateDocx();

const text =
    "Some text content for the textbox. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident.";
const optionsTextBox: OptionsTextBox = {
    align: "right",
    padding: {
        left: 10,
    },
    border: {
        color: "#B70000",
        width: 4,
    },
    fillColor: "#DDDDDD",
    width: 240,
};
docx.addTextBox(text, optionsTextBox);

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

The resulting Word document looks like:

Release notes

phpdocx 16.0:
- new method.