mlreportgen.dom.Number Class

Namespace: mlreportgen.dom

Number to include as formatted text in document

Description

Use an object of the mlreportgen.dom.Number class to convert a number to formatted text that you can include in a document.

The conversion uses the first of these format specifications that it finds:

1. The specification in the mlreportgen.dom.NumberFormat object in the Style property of the Number object

2. The specification in the NumberFormat object in the Style property of the element, such as a paragraph, list, or table, that contains the Number object

3. The default specification set by mlreportgen.dom.setDefaultNumberFormat

If the conversion does not find a format specification, the conversion uses the maximum number of digits needed to represent the number accurately.

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

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

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Creation

Description

numberObj = mlreportgen.dom.Number creates an empty Number object. Use the Value property to specify the number to convert to formatted text.

numberObj = mlreportgen.dom.Number(value) creates a Number object with the specified value.

.

numberObj = mlreportgen.dom.Number(value,stylename) creates a Number object with the Value property set to value and the StyleName property set to stylename.

Properties

Value — Number to convert to formatted text

0 (default) | scalar

Number to convert to formatted text, specified as a scalar. Complex numbers are not supported.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

StyleName — Name of stylesheet-defined style

[] (default) | character vector | string scalar

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

Style — Style format of converted number

{} (default) | cell array of DOM format objects

Style format of this number when converted to text, specified as a cell array of DOM format objects. Use an mlreportgen.dom.NumberFormat object to specify the precision of the converted number. The formats override the corresponding formats defined by the stylesheet style specified by the StyleName property.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: cell

CustomAttributes — Custom attributes of document element

[] (default) | array of mlreportgen.dom.CustomAttribute objects

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

Parent — Parent of this object

document element object

Parent of this object, specified as a document element object. A document element must have only one parent.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Children — This property is ignored

not applicable

The class ignores this property.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

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

Methods

Public Methods

clone

copiedObj = clone(soureceObj) returns a copy of the mlreportgen.dom.Number object specified by soureceObj. The copy includes the children of the source object, but not the parent. Note Do not append the same object to a document more than once. Use clone to create a copy when you want to reuse the same content elsewhere in a document. Input Arguments soureceObj — Object to clone, specified as an mlreportgen.dom.Number object Return Values copiedObj— Object copy, returned as an mlreportgen.dom.Number object For more information, see the equivalent method for the mlreportgen.dom.Paragraph class, clone.

toString

Convert number to formatted text

Examples

Format a Number in a Report

Represent a number as a Number object. Use a NumberFormat object to specify four digits of precision after the decimal point.

import mlreportgen.dom.*
  
rpt = Document("Report with NumberFormat","pdf");

n = Number(pi);
n.Style = [n.Style {NumberFormat("%0.4f")}];
append(rpt,n);
  
close(rpt);
rptview(rpt);

More About

Append content to mlreportgen.dom.Number object

You can append an mlreportgen.dom.CustomElement object to an mlreportgen.dom.Number object.

append(classObj,customElementObj);

Append mlreportgen.dom.Number object to DOM class object

You can append an mlreportgen.dom.Number object to these DOM class objects:

• mlreportgen.dom.Container

• mlreportgen.dom.CustomElement

• mlreportgen.dom.Document

• mlreportgen.dom.DocumentPart

• mlreportgen.dom.DOCXPageFooter

• mlreportgen.dom.DOCXPageHeader

• mlreportgen.dom.EmbeddedObject

• mlreportgen.dom.ExternalLink

• mlreportgen.dom.Group

• mlreportgen.dom.Heading

• mlreportgen.dom.Heading1

• mlreportgen.dom.Heading2

• mlreportgen.dom.Heading3

• mlreportgen.dom.Heading4

• mlreportgen.dom.Heading5

• mlreportgen.dom.Heading6

• mlreportgen.dom.HTMLPage (since R2024a)

• mlreportgen.dom.InternalLink

• mlreportgen.dom.LinkTarget

• mlreportgen.dom.ListItem

• mlreportgen.dom.OrderedList

• mlreportgen.dom.Paragraph

• mlreportgen.dom.PDFPageFooter

• mlreportgen.dom.PDFPageHeader

• mlreportgen.dom.Preformatted

• mlreportgen.dom.TableEntry

• mlreportgen.dom.TableHeaderEntry

• mlreportgen.dom.Template

• mlreportgen.dom.TemplateDocumentPart (since R2023b)

• mlreportgen.dom.UnorderedList

Tips

• When you append mlreportgen.dom.Number objects in documents, the object content appends differently depending on the document format. In HTML documents, the content appends in the same line. In PDF and DOCX documents, the content appends in separate lines. To append the content in the same line, create a mlreportgen.dom.Paragraph object, append the content to the paragraph object by using the append method, then append the paragraph object to the document object.

Version History

Introduced in R2021a