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

expand all

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

expand all

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

Properties

expand all

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

Tag for the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier to identify where an issue occurred during document generation.

The possible values are:

  • 0— uses regular weight text

  • 1— renders text in bold

Data Types: logical

Examples

collapse all

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);