JavaScript API: addProperties

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addProperties

PREMIUM

TRIAL / ADVANCED

Adds properties.

Note

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

Description

addProperties (options: OptionsProperties): this

interface OptionsProperties {
    /** Category */
    category?: string;
    /** Company */
    company?: string;
    /** Created date. W3CDTF without time zone */
    created?: string;
    /** Creator */
    creator?: string;
    /** Description */
    description?: string;
    /** Keywords */
    keywords?: string;
    /** Last modified by */
    lastModifiedBy?: string;
    /** Manager */
    manager?: string;
    /** Modified date. W3CDTF without time zone */
    modified?: string;
    /** Revision */
    revision?: string;
    /** Subject */
    subject?: string;
    /** Title */
    title?: string;
}

Code samples

Example #1

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

const docx = new CreateDocx();

// add properties
const properties: OptionsProperties = {
    company: "My company",
    category: "My category",
    creator: "My creator",
    description: "The description could be much longer than this.",
    keywords: "keyword 1, keyword 2, keyword 3",
    manager: "My manager",
    subject: "My subject",
    title: "My title",
};
docx.addProperties(properties);

// add date properties
const propertiesDate: OptionsProperties = {
    created: "2016-11-21T09:00:00Z", // force a value
    modified: new Date().toISOString(), // dynamic value
};
docx.addProperties(propertiesDate);

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

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.