mlreportgen.dom.FontFamily class

Package: mlreportgen.dom

Font family

Description

Properties of font family to be used to format document text.

Construction

fontFamilyObj = FontFamily() creates a Times New Roman font family.

fontFamilyObj = FontFamily(fontStr) creates the specified font family.

Input Arguments

fontStr — Font family

character vector

Font family, specified as a character vector.

Output Arguments

fontFamilyObj — Font family

mlreportgen.dom.FontFamily object

Font family, represented by an mlreportgen.dom.FontFamily object.

Properties

BackupFamilyNames — Backup font families

cell array

For HTML documents only. Cell array of character vectors specifying font families that a browser can use if the font family specified in FamilyName is not available on a system.

ComplexScriptFamilyName — Font family for complex scripts

character vector

For Word documents only. Font family to substitute in a locale that requires a complex script (such as Arabic) to render text, specified as a character vector.

EastAsiaFamilyName — Font family for East Asian locales

character vector

For Word documents only. Font family to substitute in an East Asian locale, such as China, Japan, or Korea, specified as a character vector.

FamilyName — Font family to use

character vector

Font family to use for document text, specified as a character vector.

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.