mlreportgen.dom.Hyphenation class

Package: mlreportgen.dom

Enable hyphenation

Description

Use an object of the mlreportgen.dom.Hyphenation class to specify the hyphenation behavior for paragraphs and table cells. A Hyphenation object affects only a PDF report.

By default, hyphenation is disabled for paragraphs and table cells. When hyphenation is disabled, where possible, a line break occurs between words. When necessary to prevent overflow, a line break may occur anywhere in a word.

When hyphenation is enabled, a line break occurs at the end of a syllable and a hyphenation character is inserted. If a table cell contains a long sequence of numbers or letters that have no clear syllable breaks, overflow can occur. The table stretches to accommodate the overflow.

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

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Creation

Description

h = mlreportgen.dom.Hyphenation() enables hyphenation and sets the Value property to '-'.

h = mlreportgen.dom.Hyphenation(type) specifies whether to hyphenate and the hyphenation character to use.

Input Arguments

type — Type of hyphenation

false | true | '-' | ' '

Type of hyphenation, specified as one of these values:

• true — Enables hyphenation and sets the Value property to '-'.

• '-' — Enables hyphenation and sets the Value property to '-'.

• ' ' — Enables hyphenation and sets the Value property to a space (' ').

• false — Disables hyphenation and sets the Value property to [].

Properties

Id — ID for this document element

character vector | string scalar

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

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Tag — Tag for this document element

character vector | string scalar

Tag for this document element, specified as a character vector or string scalar.

The DOM 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. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Value — Hyphenation character

'-' (default) | true | ' ' | false | []

Hyphenation character, specified as one of these values:

• true — Enables hyphenation and uses a hyphen (-) for the hyphenation character.

• '-' — Enables hyphenation and uses a hyphen (-) for the hyphenation character.

• ' ' — Enables hyphenation and uses a space for the hyphenation character.

• false — Disables hyphenation.

• [] — Disables hyphenation.

Examples

Enable Hyphenation in a PDF Table

To enable hyphenation in a PDF table, add a Hyphenation object to the TableEntriesStyle property of the mlreportgen.dom.Table object. Use the default hyphenation character, '-'.

import mlreportgen.dom.*

d = Document('myreport','pdf');

open(d);

data = '/mylongpath/hyphenation/example/myveryveryveryverylongpathname.doc';
table = Table({data});
table.Width = '2in'; 
table.TableEntriesStyle = {Hyphenation(true)};
append(d,table);

close(d);
rptview(d);

Version History

Introduced in R2016b

R2020b: Behavior change for hyphenation

Starting in R2020b:

• Hyphenation is disabled, by default, for paragraphs and tables.

• When hyphenation is disabled, where possible, a line break occurs between words. If necessary to prevent overflow, a line break can occur anywhere in a word.

• When hyphenation is enabled, a line break and hyphenation character occur only at the end of a syllable. If a table cell contains a long sequence of numbers or letters that have no clear syllable breaks, overflow can occur. The table stretches to accommodate the overflow.

Before R2020b:

• Hyphenation was disabled for paragraphs. Hyphenation was enabled for tables and the default hyphenation character was an empty space.

• When hyphenation was disabled, a line break occurred only between words, which resulted in an overflow when a word extended past the boundary of a page or table cell.

• When hyphenation was enabled, a line break and hyphenation character could occur anywhere in a word in a paragraph or table.