mlreportgen.dom.ListStyleType Class

Namespace: mlreportgen.dom

Bullet or number style for HTML and PDF output

Description

Use objects of the mlreportgen.dom.ListStyleType class to specify the bullet or number style for an mlreportgen.dom.ListItem object for HTML and PDF output.

Note

The default fonts used for PDF output support commonly used bulleted and numbered list item styles. For rarer styles, you must specify a font family that supports the style in the style sheet or the Style property of the item list. You must also configure the DOM API to use the specified font family. See Configure PDF Fonts.

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

Creation

Description

ListStyleObj = ListStyleType creates a ListStyleType object and sets the Value property to "disc".

ListStyleObj = ListStyleType(value) creates a ListStyleType object and sets the Value property to value.

Properties

Value — Bullet or number style

"disc" (default) | character vector | string scalar

Bullet or number style, specified as a character vector or string scalar with one of these values:

Value	Marker Description	Supported Output Types
"armenian"	Armenian numbering ex: մեկ, երկու, երեք, ...	HTML, PDF
"circle"	Open circle	HTML, PDF
"cjk-ideographic"	Plain ideographic numbers ex: 一, 二, 三, ...	HTML, PDF
"decimal"	Decimal number ex: 1, 2, 3, ...	HTML, PDF
"decimal-leading-zero"	Decimal number with leading zero ex: 01, 02, 03, ...	HTML, PDF
"disc"	Filled circle	HTML, PDF
"georgian"	Georgian numbering ex: ერთი‎, ორი, სამი, ...	HTML, PDF
"hebrew"	Hebrew numbering ex: א, ב‎, ג, ...	HTML, PDF
"hiragana"	Hiragana numbering ex: あ, い, う, ...	HTML, PDF
"hiragana-iroha"	Hiragana-iroha numbering ex: い, ろ, は, ...	HTML, PDF
"katakana"	Katakana numbering ex: ア, イ, ウ, ...	HTML, PDF
"katakana-iroha"	Katakana-iroha numbering ex: イ, ロ, ハ, ...	HTML, PDF
"lower-alpha"	Lowercase alphabetic numbering ex: a, b, c, ...	HTML, PDF
"lower-greek"	Lowercase Greek alphabetic numbering ex: α, β, γ, ...	HTML, PDF
"lower-latin"	Lowercase Latin alphabetic numbering ex: a, b, c, ...	HTML, PDF
"lower-roman"	Lowercase Roman numerals ex: i, ii, iii, ...	HTML, PDF
"none"	No marker	HTML, PDF
"square"	Filled square	HTML, PDF
"upper-alpha"	Uppercase alphabetic numbering ex: A, B, C, ...	HTML, PDF
"upper-greek"	Uppercase Greek alphabetic numbering ex: Α, Β, Γ, ...	HTML, PDF
"upper-latin"	Uppercase alphabetic numbering ex: A, B, C, ...	HTML, PDF
"upper-roman"	Uppercase Roman numerals ex: I, II, III, ...	HTML, PDF

Tag — Tag for mlreportgen.dom.ListStyleType object

character vector | string scalar

Tag for the mlreportgen.dom.ListStyleType 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

Id — Object identifier for mlreportgen.dom.ListStyleType object

character vector | string scalar

Object identifier for the mlreportgen.dom.ListStyleType 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

Examples

Use Greek Numbering in a List for HTML Output

Create a document mylist for HTML, the default output type. Add a paragraph to the document and define two list items, giving each the ListStyleType property of "lower-greek". Create an ordered list object procedure and append the two list items to it, and then append the unordered list to the document.

import mlreportgen.dom.*;
d = Document("mylist");
p = Paragraph("This list uses Greek numbering.");
append(d,p);

step1 = ListItem("Do this step first.");
step2 = ListItem("Now do this step.");
step1.Style = {ListStyleType("lower-greek")};
step2.Style = {ListStyleType("lower-greek")};
procedure = OrderedList();
append(procedure,step1);
append(procedure,step2);
append(d,procedure);

close(d);
rptview("mylist");

Version History

Introduced in R2016a