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
Input Arguments
items
— Content to include in unordered list
array of doubles | array of character vectors | categorical array | cell array
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
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.UnorderedList
object
character vector | string scalar
Object identifier for the 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
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.UnorderedList
object
character vector | string scalar
Tag for the 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
Examples
Create an Unordered List
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
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)