In This Topic ▼

useBackgroundColor Property

Summary

Indicates whether the HTML document will use the a background color or not.

Syntax

TypeScript

JavaScript

Object.defineProperty(HtmlDocumentOptions.prototype, 'useBackgroundColor', 
   get: function(), 
   set: function(value) 
)

useBackgroundColor: boolean;

Property Value

true to use the background color in the HTML document; false, otherwise.

Remarks

The HTML format supports adding a background color to the final document. To use a background color, set the value of the UseBackgroundColor property to true and set the color value required in the BackgroundColor property.

If the value of the UseBackgroundColor property is false, then the final document will not contain a background color and the value of the BackgroundColor property will not be used when creating the HTML document.

Requirements

Target Platforms