mlreportgen.dom.AutoNumber class

Package: mlreportgen.dom
Superclasses:

Automatically generated number

Description

Automatically generated number for a DOM document element object.

Construction

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

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

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

Input Arguments

stream — Numbering stream for generating the number

character vector

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.

styleName — Name of number style defined in the template

character vector

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

Output Arguments

autoObj — Automatically created number object

mlreportgen.dom.AutoNumber object

Automatically created number object, specified as an mlreportgen.dom.AutoNumber object.

Properties

BackgroundColor — Background color

character vector

Background color, specified as either:

• The name of a color. The name must be a CSS color name. See https://www.crockford.com/wrrrld/color.html.

• A hexadecimal RGB (truecolor) value as #RRGGBB. For example, #0000ff is a shade of blue.

Bold — Option to use bold for number

[] (default) | logical value

To make text bold, set this property to true or 1. If this property is empty and the StyleName property for this document element specifies a style sheet style, the weight of the number is determined by that style. Setting the Bold property adds a corresponding mlreportGen.dom.Bold format object to the Style property of this document element. Removing the Bold property setting removes the object.

Data Types: logical

Color — Text color

character vector

Text color, specified as either:

• The name of a color. The name must be a CSS color name. See https://www.crockford.com/wrrrld/color.html.

• A hexadecimal RGB (truecolor) value as #RRGGBB. For example, #0000ff is a shade of blue.

CustomAttributes — Custom attributes of document element

array of mlreportgen.dom.CustomAttribute objects

The output format must support the custom attributes of this document element.

FontFamilyName — Name of font family for text

character vector

The name of a font family.

To specify substitutions for this font, do not set this property. Instead create and add a mlreportgen.dom.FontFamily object to the Style property of this document element.

Setting the FontFamilyName property adds a corresponding mlreportGen.dom.FontFamily format object to the Style property for this document element. Setting the FontFamilyName property is the same as setting the FontName property of mlreportgen.dom.FontFamily. Removing the FontFamilyName property setting removes the object.

FontSize — Font size

character vector

If you need to specify substitutions for this font, do not set this property. Instead create and add a mlreportgen.dom.FontFamily object to the Style property of this document element.

Setting the FontSize property adds a corresponding mlreportGen.dom.FontSize format object to the Style property for this document element. Removing the FontSize property setting removes the object.

Font size, specified in the form valueUnits, where Units is an abbreviation for the units. Use one of these abbreviations for the units.

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Id — ID for document element

character vector

ID for this document element, specified as a character vector. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Italic — Option to use italics for a number

[] (default) | logical value

To use italics for a number, set this property to true. If this property is empty and the StyleName property for this document element specifies a style sheet style, the slant of the number is determined by that style. Setting the Italic property adds a corresponding mlreportGen.dom.Italic format object to the Style property of this document element. Removing the Italic property setting removes the object.

Data Types: logical

Strike — Text strikethrough

[] (default) | 'none' | 'single' | 'double'

Text strikethrough, specified as one of these values:

• 'none' — Do not use strikethrough.

• 'single' — Use a single line for strikethrough.

• 'double' — Use a double line for strikethrough for Word documents.

Setting the Strike property adds a corresponding mlreportGen.dom.Strike format object to the Style property for this document element. Removing the Strike property setting removes the object.

Style — Formats that define the element style

array of format objects

The formats specified by this property override corresponding formats defined by the style sheet style specified by the StyleName property of this element. Formats that do not apply to this element are ignored.

StyleName — Style for the number

character vector

The style specified by styleName must be defined in the template used to create the document element to which this number is appended.

Tag — Tag for document element

character vector

Tag for the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier to identify where an issue occurred during document generation.

Underline — Type of underline, if any, for text

[] (default) | character vector

You can specify one of the following types of underlines.

Border Value	Description	Supported Output Types
'dash'	Dashed underline	Word
'dashedHeavy'	Line with heavy dashes	Word
'dashLong'	Line with long dashes	Word
'dashLongHeavy'	Line with heavy long dashes	Word
'dashDotDotHeavy'	Line with heavy dashes with two dots between the dashes	Word
'dashDotHeavy'	Heavy dash-dot line	Word
'dotted'	Dotted line	Word
'dottedHeavy'	Thick dotted line	Word
'dotDash'	Dot-dash line	Word
'dotDotDash'	Dot-dot-dash line	Word
'dashDotHeavy'	Heavy dot-dash line	Word
'double'	Double line	Word
'none'	Do not use underlining	All output types
'single'	Single line	All output types
'thick'	Thick line	Word
'wave'	Wavy line	Word
'waveyDouble'	Double wavy line	Word
'waveyHeavy'	Heavy wavy	Word
'words'	Underline non-space characters only	Word

If this property is empty and StyleName property of this document element specifies a style sheet style, the type of underline is determined by that style.

To specify the color as well as the type of the underline, do not set the Underline property. Instead, set the Style property of this document element to include an mlreportgen.dom.Underline format object that specifies the desired underline type and color.

Setting the Underline property adds a corresponding mlreportgen.dom.Underline format object to the Style property for this document element. Removing the Underline property setting removes the object.

WhiteSpace — White space and line breaks in text

[] (default) | character vector

To specify how to handle white space, use one of these values.

Value	Description	Supported Output Types
'normal' (default)	For HTML and PDF, removes spaces at beginning and end of text. Multiple spaces within the text collapse to single space. For Word, removes spaces at beginning and end of text.	All output types
'nowrap'	Sequences of white space collapse into a single white space. Text never wraps to the next line.	HTML
'preserve'	Preserves spaces and line feeds. Acts like the <pre> tag in HTML.	All output types
'pre'	Preserves white space. Text wraps only on line breaks. Acts like the <pre> tag in HTML.	HTML and PDF
'pre-line'	Sequences of white space collapse into a single white space. Text wraps.	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 WhiteSpace format object to Style property. Removing the WhiteSpace property setting removes the WhiteSpace object.

Methods

Method	Purpose
append Use AutoNumber.append in a similar way to how you use ExternalLink.append.	Append a custom element to this number.
clone Use AutoNumber.clone in a similar way to how you use Paragraph.clone.	Copy the number object.

Examples

Use Automatically Generated Numbers for Chapters and Tables

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);