JSON API - setBackgroundColor

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

setBackgroundColor

PREMIUM

TRIAL / ADVANCED

Sets the background color of the Word document.

Note

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

JSON data

{
    "color": "string"
}

Key	Description
color	Hexadecimal color value: FFFF00, FA0000, 4578AA...

Code samples

Example #1

{
    "actions": [
        {
            "action": "setBackgroundColor",
            "data": {
                "color": "FFFFCC"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This document should have a pale yellow background color."
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.