mlreportgen.dom.FirstLineIndent class

Package: mlreportgen.dom
Superclasses:

Indent first line of paragraph

Description

Indent first line of a paragraph.

Construction

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

expand all

Width of indentation of the first line of the paragraph, specified in the form valueUnits. Units is an abbreviation for the units. Valid abbreviations are:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

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

Output Arguments

expand all

Indentation for first line of paragraph, represented by an mlreportgen.dom.FirstLineIndent object.

Properties

expand all

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

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 for the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier to identify where an issue occurred during document generation.

Width of indentation of first line of paragraph in the form valueUnits. Units is an abbreviation for the units. Valid abbreviations are:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points