mlreportgen.dom.LineSpacing class

Package: mlreportgen.dom

Spacing between lines of paragraph

Description

Specifies the spacing between lines of a paragraph.

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

Creation

Description

lineSpacingObj = LineSpacing() specifies line spacing equal to the height of one line at the paragraph font size.

lineSpacingObj = LineSpacing(multiple) specifies a line spacing as a multiple of the paragraph text line height (for example, 1.5).

lineSpacingObj = LineSpacing(spacingHeight) specifies line spacing as a dimension, for example, '10pt'.

lineSpacingObj = LineSpacing(spacingHeight,spacingType) specifies line spacing value and type.

Input Arguments

multiple — Multiple of paragraph line height

1 (default) | scalar

Scalar that specifies the line spacing relative to the paragraph text line height.

spacingHeight — Height of line spacing

character vector

Height of line spacing in the form valueUnits, where Units is an abbreviation for the units. These abbreviations are valid:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

spacingType — Line spacing type

'multiple' | 'exact' | 'atleast'

Type of line spacing, specified as one of these values:

• 'multiple' — Value is the spacing in terms of number of lines.

• 'exact' — Value is the exact size of the line spacing.

• 'atleast' — Value is the minimum size of the line spacing (applies only to Microsoft^® Word)

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

Type — Option to specify type of line spacing height

'multiple' | 'exact' | 'atleast'

Type of line spacing, specified as one of these values:

• 'multiple' — Value is the spacing in terms of number of lines.

• 'exact' — Value is the exact size of the line spacing.

• 'atleast' — Value is the minimum size of the line spacing (applies only to Word)

Value — Height of line spacing

'1in' (default) | character vector

Height of line spacing in the form valueUnits, where Units is an abbreviation for the units. These abbreviations are valid:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Examples

Create Line Spacing 1.5 Times the Height of the Paragraph Text Lines

p = Paragraph();
p.Style = {LineSpacing(1.5)};

Version History

Introduced in R2014b