Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

mlreportgen.dom.Document.getAutoNumberStream

Package: mlreportgen.dom

Return numbering stream

Syntax

autoNumStreamOut = getAutoNumberStream(docObj,streamName)

Description

example

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

Examples

collapse all

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

collapse all

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

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

Output Arguments

collapse all

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

Introduced in R2014b

Was this topic helpful?