mlreportgen.dom.OrderedList Class

Namespace: mlreportgen.dom

Create ordered list

Description

Create an ordered (numbered) list.

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

Creation

Description

orderedListObj = OrderedList creates an empty ordered list.

orderedListObj = OrderedList(items) creates an ordered list of the specified items.

Input Arguments

items — Content to include in ordered list

one-dimensional array of doubles | one-dimensional array of character vectors | one-dimensional categorical array | one-dimensional cell array

Content to include in an ordered list, specified as a:

• One-dimensional array of doubles

• One-dimensional array of character vectors

• One-dimensional categorical array

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

Properties

CustomAttributes — Custom attributes of document element

[] (default) | array of mlreportgen.dom.CustomAttribute objects

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

Id — Object identifier for mlreportgen.dom.OrderedList object

character vector | string scalar

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

Style — Format specification

{} (default) | array of DOM format objects

Format specification for this document element object, specified as an array of DOM 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 document element object are ignored.

Attributes:

NonCopyable

true

Stylename — List style name

character vector

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

Tag — Tag for mlreportgen.dom.OrderedList object

character vector | string scalar

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

Public Methods

Method	Purpose
append	Append items to this list.
clone Use the OrderedList.clone method similar to how you use Paragraph.clone.	Copy the list.

Examples

Create an Ordered List

import mlreportgen.dom.*;
d = Document('test','html');

ol = OrderedList({Text('a'), 'b', 1,...
    {'c', Paragraph('d')}});
append(d,ol);

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

Version History

Introduced in R2014b

R2019b: Default Indentation for Ordered List in Word Report

Starting in R2019b, the default indentation for an ordered list in a Microsoft^® Word report is 0.25 inches. In previous releases, by default, an ordered list was unindented in a Word report. In MATLAB^® R2019b or a later release, to generate an unindented ordered list, set the outer margin of the list to 0.25 inches.

ol = OrderedList({'a', 'b', 'c'});
ol.Style = {mlreportgen.dom.OuterMargin('0.25in','0in')}; 

Specify 0.25 inches, not 0 inches, to allow for the 0.25 inches required for the list item numbers.