Main Content

mlreportgen.dom.Color Class

Namespace: mlreportgen.dom

Color of document element

Description

Use objects of the mlreportgen.dom.Color class to specify the color of a document element.

The mlreportgen.dom.Color class is a handle class.

Creation

Description

colorObj = mlreportgen.dom.Color creates a black color object.

example

colorObj = mlreportgen.dom.Color(colorName) sets the Value property to colorName.

Properties

expand all

Hexadecimal RGB color value, specified as a character vector. You can use either uppercase or lowercase letters as part of a hexadecimal value.

Example: "#8b008b" specifies a dark magenta color.

Attributes:

NonCopyable
true

Data Types: char | string

Color of the document element, specified as one of these formats:

FormatData Type
CSS color nameSpecify as a character vector or string scalar. The name must be a CSS color name. See https://www.w3.org/wiki/CSS/Properties/color/keywords.
Hexadecimal RGB valueSpecified as a character vector or string scalar using the format #RRGGBB. Use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. You can use either uppercase or lowercase letters as part of a hexadecimal value.
Decimal RGB color valueSpecify three comma-separated positive integers, values, in the string "rgb(values)". The digits specify the red, green, and blue values. Each value ranges from 0 to 255.
Decimal percent RGB color valueSpecify a row vector of three positive numerical values. The digits specify the red, green, and blue values. Each value ranges from 0 to 1.

Example: "red" specifies a red color using a CSS color name.

Example: "#0000ff" specifies a blue color using a hexadecimal RGB value.

Example: "rgb(128,0,128)" specifies a purple color using a decimal RGB color value.

Example: [0.5 0 0.5] specifies a purple color using a decimal percent RGB color value.

Attributes:

NonCopyable
true

Data Types: double | char | string

Tag for mlreportgen.dom.Color object, specified as a character vector or string scalar. The DOM API generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable
true

Data Types: char | string

Object identifier for mlreportgen.dom.Color object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable
true

Data Types: char | string

Methods

expand all

Examples

collapse all

Create a blue color object and apply it to a paragraph. Instead of specifying the CSS color name 'blue', you could use the hexadecimal value '#0000ff'.

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);

colorfulStyle = {Bold,Color('blue')};
p = Paragraph('deep sky blue paragraph');
p.Style = colorfulStyle;
append(d,p);

close(d);
rptview('test',doctype);

Version History

Introduced in R2014b