mlreportgen.dom.TemplateUnorderedListLevelStyle Class

Namespace: mlreportgen.dom

Style formats for a specific list level in a TemplateUnorderedListStyle object

Since R2024a

Description

This class represents a level of an unordered list style. Creating an mlreportgen.dom.TemplateUnorderedListLevelStyle object populates the object's Levels property with instances of this class. Use the LevelStyles property to format the unordered list's levels.

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Properties

Level — List level that this object formats

double

List level that this object formats, specified as an integer.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Data Types: double

Formats — Style sheet formats

[] (default) | array of DOM formatting objects

Style sheet formats, specified as an array of DOM formatting objects. These formats define how this style affects report content.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

BulletStyle — Bullet style applied to this list level

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

Style of bullet used for this list level, specified as one of these values.

Value	Marker Description	Supported in Microsoft® Word	Supported in HTML and PDF
"circle"	Open circle	yes	yes
"cjk-ideographic"	Plain ideographic numbers Example: 一, 二, 三, ...	yes	yes
"decimal"	Decimal number Example: 1, 2, 3, ...	yes	yes
"decimal-hierarchical"	Numbers that include the numbers of parent list levels. Example: 1. 1.1 1.2 1.2.1 1.2.2 2.	yes	no
"decimal-leading-zero"	Decimal number with leading zero Example: 01, 02, 03, ...	yes	yes
"disc"	Filled circle	yes	yes
"hiragana"	Hiragana numbering Example: あ, い, う, ...	no	yes
"hiragana-iroha"	Hiragana-iroha numbering Example: い, ろ, は, ...	no	yes
"katakana"	Katakana numbering Example: ア, イ, ウ, ...	yes	yes
"katakana-iroha"	Katakana-iroha numbering Example: イ, ロ, ハ, ...	yes	yes
"lower-alpha"	Lowercase alphabetic numbering Example: a, b, c, ...	yes	yes
"lower-greek"	Lowercase Greek alphabetic numbering Example: α, β, γ, ...	no	yes
"lower-latin"	Lowercase Latin alphabetic numbering Example: a, b, c, ...	yes	yes
"lower-roman"	Lowercase Roman numerals Example: i, ii, iii, ...	yes	yes
"none"	No marker	yes	yes
"upper-alpha"	Uppercase alphabetic numbering Example: A, B, C, ...	yes	yes
"upper-latin"	Uppercase alphabetic numbering Example: A, B, C, ...	yes	yes
"upper-roman"	Uppercase Roman numerals Example: I, II, III, ...	yes	yes

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

BulletFormats — Bullet formats applied to this list level

[] (default) | array of DOM formatting objects

Formats that are applied to only the list bullets for this level, specified as an array of DOM formatting objects.

Note

The PDF template output ignores this property.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Tag — Tag

character vector | string scalar

Tag, 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. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Id — Object identifier

character vector | string scalar

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Examples

Create and Use a Multilevel Unordered List Style in a Template

Create a multilevel unordered list style in a template and then apply that style in your document.

Create the Style in the Template

Import the DOM API namespace so that you do not have to use long, fully qualified names.

import mlreportgen.dom.*;
t = Template("myTemplate","pdf");
open(t);

Create a list style.

listStyle = TemplateUnorderedListStyle("myUnorderedListStyle");

Define formats for level 1.

level1Style = listStyle.LevelStyles(1);
level1Style.Formats = [Color("blue"), FontSize("32pt")];

Define formats for level 2.

level2Style = listStyle.LevelStyles(2);
level2Style.Formats = [Color("red"), FontSize("16pt")];

Add style to the stylesheet.

addStyle(t.Stylesheet,listStyle);

Close the template.

close(t);

Use the Style from the Template in a Document

Create a document using the generated template.

d = Document("myDoc","pdf","myTemplate");
open(d);

Create a list object with 2 levels.

list = UnorderedList(["first level item 1", "first level item 2"]);
secondLevelList = UnorderedList(["second level item 1", "second level item 2"]);
append(list, secondLevelList);

Set the style name.

list.StyleName = "myUnorderedListStyle";

Add the list to the document.

append(d,list);

Close and view the document.

close(d);
rptview(d);

Version History

Introduced in R2024a