JavaScript API: addText

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addText

PREMIUM

TRIAL / ADVANCED

Adds text.

Note

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

Description

addText (options: string | (OptionsText | WordFragment)[], optionsParagraph: OptionsParagraph = {}): this

interface OptionsText extends OptionsRpr {
    /** Text content */
    text: string;
}

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";
}

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;
}

Code samples

Example #1

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

const docx = new CreateDocx();

docx.addText("New content.");

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

The resulting Word document looks like:

Example #2

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

const docx = new CreateDocx();

const textA: OptionsText = {
    bold: true,
    italic: true,
    fontSize: 14,
    text: "New content",
};
const textB: OptionsText = {
    color: "0000FF",
    font: "Times New Roman",
    text: " & other content.",
};
docx.addText([textA, textB]);

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

The resulting Word document looks like:

Example #3

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

const docx = new CreateDocx();

const text =
    "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, sunt in culpa qui officia deserunt mollit anim id est laborum.";

const optionsParagraph: OptionsParagraph = {
    align: "justify",
    bold: true,
    indentation: {
        firstLine: 200,
    },
    keepLines: true,
    keepNext: true,
};

docx.addText(text, optionsParagraph);

const textA: OptionsText = {
    bold: false,
    italic: true,
    fontSize: 14,
    text: "New content.",
};
const textB: OptionsText = {
    color: "0000FF",
    font: "Times New Roman",
    text: " Other content.",
};
docx.addText([textA, textB], optionsParagraph);

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

The resulting Word document looks like:

Example #4

import {
    CreateDocx,
    OptionsDateTime,
    OptionsLink,
    WordFragment,
} from "build";
import * as fs from "fs";

const docx = new CreateDocx();

// create a link WordFragment
const wordFragmentLink = new WordFragment();
const optionsLink: OptionsLink = {
    link: "https://www.phpdocx.com",
    text: "phpdocx",
};
wordFragmentLink.addLink(optionsLink);

// create texts WordFragments
const wordFragmentTextA = new WordFragment();
wordFragmentTextA.addText("A link to ");
const wordFragmentTextB = new WordFragment();
wordFragmentTextB.addText(
    " in the middle of a paragraph with the following date: "
);

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

// add the WordFragments as inline contents in the same paragraph
docx.addText([
    wordFragmentTextA,
    wordFragmentLink,
    wordFragmentTextB,
    wordFragmentDate,
]);

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

The resulting Word document looks like:

Release notes

phpdocx 15.5:
- caps, characterSpacing, em, emboss, noProof, position, shadow, smallCaps, textDirection, underlineColor, vanish, verticalAlign, widowControl and wordWrap options.

phpdocx 15.0:
- new method.