mlreportgen.dom.AutoNumberStream Class

Namespace: mlreportgen.dom

Numbering stream

Description

Use an object of the mlreportgen.dom.AutoNumberStream class to define a numbering stream that 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

CharacterCase — Character case of generated numbers

"lower" | "upper"

Character case of generated numbers, specified as:

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

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

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

CharacterType — Character type of generated numbers

"alphabetic" | "arabic" | "roman"

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

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

InitialValue — Initial value of generated number

character vector | string scalar

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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

StreamName — Name of numbering stream

character vector | string scalar

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

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

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

Version History

Introduced in R2014b