JavaScript API: createCharacterStyle

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

createCharacterStyle

PREMIUM

TRIAL / ADVANCED

Creates character style.

Note

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

Description

createCharacterStyle (name: string, styles: OptionsRpr): this

interface OptionsRpr {
    /** Bold */
    bold?: boolean;
    /** Color: HEX value */
    color?: string;
    /** 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;
    /** Character style */
    rStyle?: string;
    /** Strikethrough */
    strikethrough?: boolean;
    /** Underline */
    underline?:
        | "single"
        | "words"
        | "double"
        | "thic"
        | "dotted"
        | "dottedHeavy"
        | "dash"
        | "dashedHeavy"
        | "dashLong"
        | "dashLongHeavy"
        | "dotDash"
        | "dashDotHeavy"
        | "dotDotDash"
        | "dashDotDotHeavy"
        | "wave"
        | "wavyHeavy"
        | "wavyDouble"
        | "none";
}

Code samples

Example #1

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

const docx = new CreateDocx();

// create custom character style
const characterStyle: OptionsRpr = {
    bold: true,
    color: "FF0000",
    fontSize: 18,
    italic: true,
};
docx.createCharacterStyle("myStyle", characterStyle);

// add a text content with the new custom character style
const textA: OptionsText = {
    fontSize: 14,
    text: "New content ",
};
const textB: OptionsText = {
    rStyle: "myStyle",
    text: "and other content.",
    underline: "single",
};
docx.addText([textA, textB]);

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

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.