Main Content

mlreportgen.dom.AutoNumberStream Class

Namespace: mlreportgen.dom

Numbering stream

expand all in page

Description

A numbering stream generates a sequence of numbers for numbering chapters, tables, figures, and other document objects. To create a numbering stream object, use the createAutoNumberStream method.

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

Properties

expand all

Character case of generated numbers, specified as:

  • 'lower' — lowercase (for example, a, b ,c)

  • 'upper' — uppercase (for example, A, B, C)

Character type of generated numbers, specified as:

  • 'alphabetic' — for example, a, b, c

  • 'arabic' — for example, 1, 2, 3

  • 'roman' — for example, i, ii, iii

The value of this property should be one less than the number that you want to be generated first. For example, if you want the number of the first item to be numbered by this stream to be 2, set the value of this property to 1.

Name of numbering stream, specified as a character vector or string scalar.

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

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

Version History

Introduced in R2014b

See Also

| | |

Topics