JavaScript API: setBackgroundColor

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

setBackgroundColor

PREMIUM

TRIAL / ADVANCED

Sets background color.

Note

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

Description

setBackgroundColor (color: string): this

Code samples

Example #1

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

const docx = new CreateDocx();

docx.setBackgroundColor("FFFFCC");

docx.addText("This document should have a pale yellow background color.");

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

The resulting Word document looks like:

Release notes

phpdocx 15.5:
- new method.