mlreportgen.dom.FirstLineIndent Class

Namespace: mlreportgen.dom

Indent first line of paragraph

Description

Indent first line of a paragraph.

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

Creation

Description

firstLineIndentObj = FirstLineIndent creates an empty first line indentation format object.

firstLineIndentObj = FirstLineIndent(width) indents first line of paragraph by the specified amount.

firstLineIndentObj = FirstLineIndent(style,width) indents either the first line of the paragraph relative to the page margin or indents the subsequent lines relative to the page margin (hanging indentation).

Input Arguments

width — Width of indentation of first line of paragraph

character vector | string scalar

Width of indentation of first line of paragraph, specified as character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "10px" specifies 10 pixels. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

Example: "5pt"

style — Type of indentation

"normal" | "hanging"

Type of indentation of the first line of the paragraph, specified as one of these values:

• "normal" — indent relative to the page margin

• "hanging" — indent relative to the subsequent lines

Properties

Width — Amount of indentation

[] (default) | character vector | string scalar

Width of indentation of first line of paragraph, specified as character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "10px" specifies 10 pixels. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

Example: "5pt"

Style — Type of indentation

[] (default) | "normal" | "hanging"

Type of indentation of the first line of the paragraph, specified as one of these values:

• "normal" (default) — indent relative to the page margin

• "hanging" — indent relative to the subsequent lines

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

Version History

Introduced in R2014b