JavaScript API: addDateTime

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addDateTime

PREMIUM

TRIAL / ADVANCED

Adds date and time.

Note

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

Description

addDateTime (options: OptionsDateTime = {}, optionsParagraph: OptionsParagraph = {}): this

interface OptionsDateTime extends OptionsRpr {
    /** Date and time format. Default as "dd/MM/yyyy H:mm:ss" */
    format?: 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;
}

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

const docx = new CreateDocx();

// default date and time format
docx.addDateTime();

docx.addText("Date and time with custom format and styles:");

// custom date and time formats and styles
const dateTimeA: OptionsDateTime = {
    format: "M/d/yyyy",
    bold: true,
    color: "333333",
    fontSize: 24,
};
docx.addDateTime(dateTimeA);

const dateTimeB: OptionsDateTime = {
    format: "dd' of 'MMMM' of 'yyyy' at 'H:mm",
    color: "FF0000",
    italic: true,
};
const optionsParagraph: OptionsParagraph = {
    align: "center",
    bold: true,
};
docx.addDateTime(dateTimeB, optionsParagraph);

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

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.