mlreportgen.ppt.NumberFormat Class

Namespace: mlreportgen.ppt

Number formatting

Since R2024b

expand all in page

Description

Use an object of the mlreportgen.ppt.NumberFormat class to specify the formatting of numbers in presentations. To specify the formatting of one number, represent the number as an object of the mlreportgen.ppt.Number class and include the NumberFormat object in the Style property of the Number object. To format all numbers in a document element, such as a paragraph, list, or table, include the NumberFormat object in the Style property of the object that represents the element.

The mlreportgen.ppt.NumberFormat class is a handle class.

Class Attributes

ConstructOnLoad
true
HandleCompatible
true

For information on class attributes, see Class Attributes.

Creation

Description

numberFormatObj = mlreportgen.ppt.NumberFormat creates a NumberFormat object. Set the Value property to the format specification.

numberFormatObj = mlreportgen.ppt.NumberFormat(value) creates a NumberFormat object and sets the Value property to the format specified by value.

example

Properties

expand all

Format specification, specified as a character vector or string scalar. The specification must be a valid format specification for the sprintf function and use one of these operators:

  • %f

  • %e

  • %E

  • %g

  • %G

Example: "%0.2f"

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Option to apply Value property to integers, specified as a numeric or logical 1 (true) or 0 (false). If true, the specified format will be applied to integers. If false, specified format will not be applied to integers.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: logical

Tag, specified as a character vector or string scalar. The PPT 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

Object identifier, specified as a character vector or string scalar. The PPT API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Examples

collapse all

Open Live Script

Add formatted numbers to a presentation by using the mlreportgen.ppt.Number and mlreportgen.ppt.NumberFormat classes. Set the number formatting for the first content slide using a default value for your session and for the second content slide to a format style for that specific Number object.

Import the PPT namespace so that you do not have to use fully qualified names for the PPT API classes.

import mlreportgen.ppt.*

Set the default number formatting for the session.

setDefaultNumberFormat("%0.6f");

Create a presentation and add a title slide.

ppt = Presentation('myPresentation.pptx');
open(ppt);
slideTitle = add(ppt,"Title Slide");
replace(slideTitle,"Title","Formatted Numbers");

Create the first title and content slide. Create an mlreportgen.ppt.Paragraph object to use for the title of the slide.

slide1 = add(ppt,"Title and Content");
p1Title = Paragraph;

Create a Number object with pi and convert it to a string with the toString method.

number1Obj = Number(pi);
formattedNumber1 = toString(number1Obj);

Append the formatted number to the paragraph.

append(p1Title,string(char(960)) + " in default format: " ...
    + formattedNumber1); % char(960) - Unicode for the pi character

Replace the title in the first title and content slide with the paragraph.

replace(slide1,"Title",p1Title);

Display the default format in the content text box.

numberFormat = getDefaultNumberFormat();
p1Content = Paragraph("Number format is : ");
p1Content.append(numberFormat);
replace(slide1,"Content",p1Content);

Create the second title and content slide. Create an mlreportgen.ppt.Paragraph object to use for the title of the slide.

slide2 = add(ppt,"Title and Content");
p2 = Paragraph;

Create a Number object with pi and convert it to a string with the toString method. Limit the decimal places of pi on this slide to two decimal points by specifying the format of the Number and overriding the default number formatting.

number2Obj = Number(pi);
number2Obj.Style = NumberFormat("%0.2f");
formattedNumber2 = toString(number2Obj);

Append the formatted number to the paragraph.

append(p2,string(char(960)) + " in individual format: " ...
    + formattedNumber2); % char(960) - Unicode for the pi character

Replace the title in the second title and content slide with the paragraph.

replace(slide2,"Title",p2);

Display the individual format in the content text box.

p2Content = Paragraph("Number format is : ");
p2Content.append("%0.2f");
replace(slide2,"Content",p2Content);

Close and view the presentation.

close(ppt);
rptview(ppt);

Version History

Introduced in R2024b

See Also

| | |