Main Content

mlreportgen.dom.UnorderedList Class

Namespace: mlreportgen.dom

Unordered (bulleted) list

Description

Specifies an unordered (bulleted) list.

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

Creation

Description

example

unorderedListObj = UnorderedList creates an empty unordered list.

unorderedListObj = UnorderedList(items) creates an unordered list of the specified list items.

Input Arguments

expand all

Content to include in an unordered list, specified as an array of doubles, an array of character vectors, a categorical array, or a one-dimensional cell array.

The cell array can contain a combination of the following:

  • A character vector

  • A number

  • A Boolean value

  • One of the following DOM objects:

    • mlreportgen.dom.Text

    • mlreportgen.dom.Paragraph

    • mlreportgen.dom.ExternalLink

    • mlreportgen.dom.InternalLink

    • mlreportgen.dom.Table

    • mlreportgen.dom.Image

    • mlreportgen.dom.CustomElement

  • Horizontal one-dimensional array (for a sublist)

To append an unordered list, use an UnorderedList DOM object instead of using the items argument.

Properties

expand all

Custom attributes of this document element, specified as an array of mlreportgen.dom.CustomAttribute objects. The custom attributes must be supported by the output format of the document element to which this object is appended.

Attributes:

NonCopyable
true

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

Format specification for this document element object, specified as an array of format objects. The formats specified by this property override corresponding formats specified by the StyleName property of this element. Formats that do not apply to this element are ignored.

Attributes:

NonCopyable
true

Data Types: cell

The style specified by Stylename must be defined in the template used to create the document element to which you append this list.

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

Methods

expand all

Examples

collapse all

import mlreportgen.dom.*;
d = Document('mydoc');

ul = UnorderedList({Text('a'),'b',1,{'c',Paragraph('d')}});
append(d,ul);

close(d);
rptview('mydoc','html');

Version History

Introduced in R2014b