getAutoNumberStream

Class: mlreportgen.dom.Document
Package: mlreportgen.dom

Return numbering stream

Syntax

autoNumStreamOut = getAutoNumberStream(docObj,streamName)

Description

autoNumStreamOut = getAutoNumberStream(docObj,streamName) returns the specified numbering stream used by the document.

Examples

Return a Numbering Stream

import mlreportgen.dom.*;
myReport = Document('mydoc','html');

createAutoNumberStream(myReport,'chapterNum','I',1);
streamOut = getAutoNumberStream(myReport,'chapterNum')

streamOut = 

  AutoNumberStream with properties:

       StreamName: 'chapterNum'
    CharacterType: 'roman'
    CharacterCase: 'upper'
     InitialValue: 1
              Tag: 'dom.AutoNumberStream:500'
               Id: '500'

Input Arguments

docObj — Document that uses numbering stream

mlreportgen.dom.Document object

Document that uses the numbering stream, specified as an mlreportgen.dom.Document object.

streamName — Name of numbering stream to return

character vector

Name of the numbering stream to return, specified as a character vector.

Output Arguments

autoNumStreamOut — Numbering stream used by document

mlreportgen.dom.AutoNumberStream object

Numbering stream used by the document, represented by an mlreportgen.dom.AutoNumberStream object.