mlreportgen.dom.Bold class

Package: mlreportgen.dom
Superclasses:

Bold for text object

Description

Specifies whether to use bold for a text object

Construction

boldObj = Bold() creates a bold object that specifies to use bold for a text object.

boldObj = Bold(value) creates a bold object that specifies to use bold for a text object if value is true. Otherwise, creates a bold object that specifies to use regular weight text.

Input Arguments

value — Option to use bold or regular weight for text object

[] (default) | logical value

A setting of false (or 0) uses regular weight text. A setting of true (or 1) renders text in bold.

Data Types: logical

Output Arguments

boldObj — Bold text

mlreportgen.dom.Bold object

Bold text, represented by an mlreportgen.dom.Bold object

Properties

Id — ID for this document element

character vector | string scalar

ID for this document element, specified as a character vector or string scalar. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Tag — Tag for this document element

character vector | string scalar

Tag for this document element, specified as a character vector or string scalar.

The DOM 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. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Value — Option to use bold or regular weight for a text object

[] (default) | logical value

The possible values are:

• 0— uses regular weight text

• 1— renders text in bold

Data Types: logical

Examples

Create Paragraph With Bold and Regular-Weight Text

import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);
p = Paragraph('Bold text  ');
p.Style = {Bold};
append(d,p);

t = Text('Regular weight text');
t.Style = {Bold(false)};
append(p,t);
close(d);
rptview('test',doctype);