mlreportgen.dom.WhiteSpace Class

R2026b

Namespace: mlreportgen.dom

White space type

Description

Specifies behavior for white space and line breaks in text.

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

Creation

Description

ws = WhiteSpace(option) applies the specified white-space option to white space in a Text or Paragraph object. For PDF, you can specify WhiteSpace only for a Paragraph object.

Input Arguments

option — White-space behavior

"normal" | "nowrap" | "pre" | "pre-line" | "preserve" | "pre-wrap"

White-space behavior, specified as one of these values.

Note

Only "preserve" and "normal" affect Word output.

Value	Description
"normal" (default)	For HTML and PDF, removes leading and trailing spaces and collapses multiple spaces in text to a single space, ignoring line breaks. For Word, removes leading and trailing spaces, ignoring line breaks.
"nowrap"	Sequences of white spaces collapse into a single white space. Text does not wrap to the next line. The text continues on the same line until a <br /> tag is encountered.
"pre"	Preserves white space. Text wraps only on line breaks. Acts like the <pre> tag in HTML.
"preserve"	Preserves spaces and line breaks.
"pre-line"	Sequences of white spaces collapse into a single white space. Text wraps if necessary and on line breaks.
"pre-wrap"	Preserves white space. Text wraps if necessary and on line breaks.

Properties

Value — White-space option

"normal" (default) | "nowrap" | "pre" | "pre-line" | "preserve" | "pre-wrap" | ...

White-space option, specified as one of the values in the option input argument.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

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

Examples

Preserve Space After Colon

This example shows the effect of using the "preserve" option for each of the output formats. Preserving the trailing space is useful, for example, if you are creating a chapter title. Typically, you append an autonumber after the text "Chapter: ". Using "preserve" keeps the trailing space.

HTML Output

When you choose HTML as the output format, the multiple spaces collapse but the output preserves the trailing space.

import mlreportgen.dom.*;
doctype = "html";
d = Document("testHTML",doctype);
open(d);
     
p = Paragraph(...
    "This paragraph has extra spaces    and one after the colon: ");
% p.Style = {WhiteSpace("preserve")};

append(p,"XX");
append(d,p);
     
close(d);
rptview(d.OutputPath);

Word Output

When you choose Word as the output format, the multiple spaces do not collapse and the output preserves the trailing space. Try commenting out the WhiteSpace property. The output preserves the multiple spaces, but removes the trailing space after the colon.

import mlreportgen.dom.*;
doctype = "docx";
d = Document("test",doctype);
open(d);
     
p = Paragraph(...
    "This paragraph has extra spaces    and one after the colon: ");
p.Style = {WhiteSpace("preserve")};

append(p,"XX");
append(d,p);
     
close(d);
rptview(d.OutputPath);

PDF Output

Description of second code block

import mlreportgen.dom.*;
doctype = "pdf";
d = Document("test",doctype);
open(d);
     
p = Paragraph(...
    "This paragraph has extra spaces    and one after the colon: ");
p.Style = {WhiteSpace("preserve")};

append(p,"XX");
append(d,p);
     
close(d);
rptview(d.OutputPath);

Version History

Introduced in R2014b

R2026b: DOCX output preserves leading and trailing white space

Paragraph text in DOCX output now preserves leading and trailing white space by default. In earlier releases, DOCX output removed leading and trailing white space unless the WhiteSpace property was set to "preserve". To restore the previous behavior, set WhiteSpace to "normal".