mlreportgen.dom.AutoNumber Class

Namespace: mlreportgen.dom

Automatically generated number

expand all in page

Description

Use an object of the mlreportgen.dom.AutoNumber class to automatically generate a number for a DOM document element object.

To see what DOM objects you can append an mlreportgen.dom.AutoNumber object to, see Append mlreportgen.dom.AutoNumber object to DOM class object.

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

Creation

Description

autoObj = AutoNumber creates an automatically generated number without a specified number stream.

autoObj = AutoNumber(stream) creates a number based on the specified numbering stream.

example

autoObj = AutoNumber(stream,styleName) creates a number using the specified style.

Input Arguments

expand all

Specify a numbering stream, using the value of the mlreportgen.dom.AutoNumberStream object StreamName property.

If the specified stream does not exist, the DOM interface creates an Arabic number stream having the specified name with an initial value of 0. To use a stream with other properties, such as Roman numerals, create a stream using mlreportgen.dom.Document.createAutoNumberStream.

Name of number style defined in the template, specified as a character vector or string scalar. The style specified by styleName must be defined in the template used to create the document to which the number is appended.

Properties

expand all

Background color, specified as a character vector or string scalar that contains a CSS color name, hexadecimal RGB value, or decimal RGB value.

FormatValue
CSS color nameSpecify a CSS color name. For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.
Hexadecimal RGB valueUse the format "#RRGGBB". Use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. You can use uppercase or lowercase letters.
Decimal RGB color valueUse the format "rgb(r,g,b)", where r, g, and b are comma-separated positive integers that specify the red, green, and blue values, respectively. Each value range must be between 0 and 255.

Setting the BackgroundColor property adds a mlreportgen.dom.BackgroundColor format object to the Style property. Setting the BackgroundColor property to an empty value removes the object.

Example: "red" specifies a red color using a CSS color name.

Example: "#0000ff" specifies a blue color using a hexadecimal RGB value.

Example: "rgb(128,0,128)" specifies a purple color using a decimal RGB color value.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Whether to use bold for this document element, specified as a logical 1 (true) or 0 (false). When you specify:

  • 1 (true) — Render document element in bold text.

  • 0 (false) — Render document element in regular weight.

Note

Setting the Bold property adds a corresponding mlreportgen.dom.Bold format object to the Style property. Setting the Bold property to an empty value removes the object.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: logical

Document element object color, specified as a character vector or string scalar that contains a CSS color name, hexadecimal RGB value, or decimal RGB value.

FormatValue
CSS color nameSpecify a CSS color name. For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.
Hexadecimal RGB valueUse the format "#RRGGBB". Use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. You can use uppercase or lowercase letters.
Decimal RGB color valueUse the format "rgb(r,g,b)", where r, g, and b are comma-separated positive integers that specify the red, green, and blue values, respectively. Each value range must be between 0 and 255.

Setting the Color property adds a corresponding mlreportgen.dom.Color format object to the Style property. Setting the Color property to an empty value removes the object.

Example: "red" specifies a red color using a CSS color name.

Example: "#0000ff" specifies a blue color using a hexadecimal RGB value.

Example: "rgb(128,0,128)" specifies a purple color using a decimal RGB color value.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Name of a font family to use for text, specified as a character vector or string scalar. To specify substitutions for the font, do not specify the font family by setting this property. Instead, create and add an mlreportgen.dom.FontFamily object to the Style property.

Setting the FontFamilyName property adds a corresponding mlreportgen.dom.FontFamily format object to the Style property. Setting the FontFamilyName property is the same as setting the FontName property of an mlreportgen.dom.FontFamily object. Setting the FontFamilyName property to an empty value removes the object.

Example: "Courier New"

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Font size for document element specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "12pt" specifies twelve points. Valid abbreviations are:

  • "px" — Pixels

  • "cm" — Centimeters

  • "in" — Inches

  • "mm" — Millimeters

  • "pc" — Picas

  • "pt" — Points

Setting the FontSize property adds a corresponding mlreportgen.dom.FontSize format object to the Style property. Setting the FontSize property to an empty value removes the object.

Example: "12pt"

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Whether to use italic for document element, specified as a logical 1 (true) or 0 (false). When you specify:

  • 1 (true) — Render document element in italic text.

  • 0 (false) — Render document element in straight text.

Note

Setting the Italic property adds a corresponding mlreportgen.dom.Italic format object to the Style property. Setting the Italic property to an empty value removes the object.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: logical

Text strikethrough, specified as one of these values:

  • "none" — No strikethrough

  • "single" — Single line

  • "double" — Double line (for Word reports only)

Setting the Strike property adds a corresponding mlreportgen.dom.Strike format object to the Style property for this document element. Setting the Strike property to an empty value removes the object.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Type of underline, specified as one of the values in this table.

Underline valueDescriptionSupported Output Types

"single"

Single line

All

"words"

Underline all characters except spaces

Word

"double"

Double line

Word

"thick"

Thick line

Word

"dotted"

Dotted line

Word

"dottedHeavy"

Thick dotted line

Word

"dash"

Dashed line

Word

"dashedHeavy"

Line with heavy dashes

Word

"dashLong"

Line with long dashes

Word

"dashLongHeavy"

Line with heavy long dashes

Word

"dotDash"

Dot-dash line

Word

"dashDotHeavy"

Heavy dash-dot line

Word

"dotDotDash"

Dot-dot-dash line

Word

"dashDotDotHeavy"

Line with heavy dashes and two dots between the dashes

Word

"wave"

Wavy line

Word

"wavyHeavy"

Heavy wavy

Word

"wavyDouble"

Double wavy line

Word

"none"

No underline

All

To specify both the color and the type of the underline, do not set the Underline property. Instead, set the Style property to include an mlreportgen.dom.Underline format object that specifies the underline type and color.

Setting the Underline property adds a corresponding mlreportgen.dom.Underline format object to the Style property. Setting the Underline property to an empty value removes the object.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

How to treat white space and line breaks in text, specified as one of the values in this table. The WhiteSpace property does not apply when the Type property of the Document object is PDF.

ValueDescriptionSupported Output Types

"normal"

For HTML and PDF, this value removes spaces at the beginning and the end of text. Multiple spaces in the text collapse to a single space.

For Microsoft® Word, this value removes spaces at the beginning and end of text.

All

"nowrap"

Sequences of white space collapse into a single white space. Text never wraps to the next line.

HTML

"pre"

Preserves white space. Text wraps only on line breaks. Acts like the <pre> tag in HTML.

HTML and PDF

"preserve"

Same as "pre".All

"pre-line"

Sequences of white space collapse into a single white space. Text wraps when necessary and on line breaks.

HTML and PDF

"pre-wrap"

Preserves white space. Text wraps when necessary and on line breaks.

HTML and PDF

Setting the WhiteSpace property adds a corresponding mlreportgen.dom.WhiteSpace format object to the Style property. Setting the WhiteSpace property to an empty value removes the object.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Name of stylesheet-defined style, specified as a character vector or string scalar. The style name is the name of a style specified in the style sheet of the document or document part to which this element is appended. The specified style defines the appearance of this element in the output document unless the formats specified by the Style property of this element override it. To learn more about using style sheets, see Use Style Sheet Styles.

Note

Microsoft Word reports ignore style names that are not defined in the document template. For more information on Microsoft Word templates, see Templates for DOM API Report Programs.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Format specification for this document element object, specified as a cell 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:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: cell

Custom attributes of the 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:

GetAccess
public
SetAccess
public
NonCopyable
true

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

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

Methods

expand all

Examples

collapse all

Open Live Script
import mlreportgen.dom.*;
doctype = 'html';
d = Document('test',doctype);

p = Paragraph('Chapter ');
p.Style = {CounterInc('chapter'),CounterReset('table'),...
  WhiteSpace('preserve')};
append(p,AutoNumber('chapter'));
append(d,p);
     
p = Paragraph('Table ');
append(p,AutoNumber('chapter'));
append(p,'.');
append(p,AutoNumber('table'));
p.Style = {CounterInc('table'),WhiteSpace('preserve')};
append(d,p);
     
p = Paragraph('Chapter ');
p.Style = {CounterInc('chapter'),CounterReset('table'),...
  WhiteSpace('preserve')};
append(p,AutoNumber('chapter'));
append(d,p);
     
p = Paragraph('Table ');
append(p, AutoNumber('chapter'));
append(p,'.');
append(p,AutoNumber('table'));
p.Style = {CounterInc('table'),WhiteSpace('preserve')};
append(d,p);
     
close(d);
rptview('test',doctype);

More About

expand all

Version History

Introduced in R2014b

See Also

| | |

Topics