mlreportgen.dom.OrderedList Class

Namespace: mlreportgen.dom

Create ordered list

Description

Use an object of the mlreportgen.dom.OrderedList class to create an ordered (numbered) list.

To see what DOM objects you can append an mlreportgen.dom.OrderedList object to, see Append mlreportgen.dom.OrderedList object to DOM class object.

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.CharEntity

  • mlreportgen.dom.CustomElement (HTML, Word)

  • mlreportgen.dom.EmbeddedObject

  • mlreportgen.dom.ExternalLink

  • mlreportgen.dom.FormalTable

  • mlreportgen.dom.Image

  • mlreportgen.dom.InternalLink

  • mlreportgen.dom.ListItem

  • mlreportgen.dom.MATLABTable

  • mlreportgen.dom.Number

  • mlreportgen.dom.OrderedList

  • mlreportgen.dom.Paragraph

  • mlreportgen.dom.Preformatted

  • mlreportgen.dom.Table

  • mlreportgen.dom.Text

  • mlreportgen.dom.UnorderedList

• Horizontal one-dimensional array (for a sublist)

Properties

CustomAttributes — Custom attributes of document element

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

Custom attributes of the 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:

GetAccess	public
SetAccess	public
NonCopyable	true

Style — Format specification

{} (default) | cell array of DOM format objects

Format specification for this document element object, specified as a cell 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:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: cell

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

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

Methods

Public Methods

Method	Purpose
append	Append content to ordered list
clone	copiedObj = clone(soureceObj) returns a copy of the mlreportgen.dom.OrderedList object specified by soureceObj. The copy includes the children of the source object, but not the parent. Note Do not append the same object to a document more than once. Use clone to create a copy when you want to reuse the same content elsewhere in a document. Input Arguments soureceObj — Object to clone, specified as an mlreportgen.dom.OrderedList object Return Values copiedObj— Object copy, returned as an mlreportgen.dom.OrderedList object For more information, see the equivalent method for the mlreportgen.dom.Paragraph class, clone.

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');

More About

Append content to mlreportgen.dom.OrderedList object

You can append these DOM objects to an mlreportgen.dom.OrderedList object:

• mlreportgen.dom.CharEntity

• mlreportgen.dom.CustomElement (HTML, Word)

• mlreportgen.dom.EmbeddedObject

• mlreportgen.dom.ExternalLink

• mlreportgen.dom.FormalTable

• mlreportgen.dom.Image

• mlreportgen.dom.InternalLink

• mlreportgen.dom.ListItem

• mlreportgen.dom.MATLABTable

• mlreportgen.dom.Number

• mlreportgen.dom.OrderedList

• mlreportgen.dom.Paragraph

• mlreportgen.dom.Preformatted

• mlreportgen.dom.Table

• mlreportgen.dom.Text

• mlreportgen.dom.UnorderedList

You can append these MATLAB data types to an mlreportgen.dom.OrderedList object:

• character array — Appends and returns a mlreportgen.dom.Text object

• string scalar — Appends and returns a mlreportgen.dom.Text object

• 1D horizontal array of double values or strings — Appends and returns a mlreportgen.dom.UnorderedList object

Append mlreportgen.dom.OrderedList object to DOM class object

You can append an mlreportgen.dom.OrderedList object to these DOM class objects:

• mlreportgen.dom.Container

• mlreportgen.dom.CustomElement

• mlreportgen.dom.Document

• mlreportgen.dom.DocumentPart

• mlreportgen.dom.DOCXPageFooter

• mlreportgen.dom.DOCXPageHeader

• mlreportgen.dom.Endnote (since R2024a)

• mlreportgen.dom.Footnote (since R2024a)

• mlreportgen.dom.Group

• mlreportgen.dom.HTMLPage (since R2024a)

• mlreportgen.dom.ListItem

• mlreportgen.dom.OrderedList

• mlreportgen.dom.PDFPageFooter

• mlreportgen.dom.PDFPageHeader

• mlreportgen.dom.TableEntry

• mlreportgen.dom.TableHeaderEntry

• mlreportgen.dom.Template

• mlreportgen.dom.TemplateDocumentPart (since R2023b)

• mlreportgen.dom.UnorderedList

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.