mlreportgen.dom.InnerMargin Class

Namespace: mlreportgen.dom

Margin between content and bounding box

expand all in page

Description

Specifies the margin between the content and the bounding box of a document object. The bounding box of an object includes the inner margin and object content. If the object has a border, the box also includes the border.

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

Class Attributes

HandleCompatible
true
ConstructOnLoad
true

For information on class attributes, see Class Attributes.

Creation

Description

marginObj = mlreportgen.dom.InnerMargin creates an InnerMargin object with margin values set to [].

marginObj = mlreportgen.dom.InnerMargin(all) creates the specified margin on all sides between the content of an object and its bounding box.

example

marginObj = mlreportgen.dom.InnerMargin(left,right) creates the specified margins between the left and right sides of the content of an object and its bounding box.

marginObj = mlreportgen.dom.InnerMargin(left,right,top,bottom) creates the specified margins between sides of the content of an object and its bounding box.

Input Arguments

expand all

Margin on all sides between the object and its bounding box, specified as a 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

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

Size of the left margin between the object and its bounding box. See the all input argument for a list of valid values.

Size of the right margin between the object and its bounding box. See the all input argument for a list of valid values.

Size of the top margin between the object and its bounding box. See the all input argument for a list of valid values.

Size of the bottom margin between the object and its bounding box. See the all input argument for a list of valid values.

Properties

expand all

Size of the left margin, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "1in" specifies 1 inch. Valid abbreviations are:

  • "px" — Pixels

  • "cm" — Centimeters

  • "in" — Inches

  • "mm" — Millimeters

  • "pc" — Picas

  • "pt" — Points

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

Example: "0.5in"

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Size of the right margin, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "1in" specifies 1 inch. Valid abbreviations are:

  • "px" — Pixels

  • "cm" — Centimeters

  • "in" — Inches

  • "mm" — Millimeters

  • "pc" — Picas

  • "pt" — Points

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

Example: "0.5in"

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Size of the top margin, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "1in" specifies 1 inch. Valid abbreviations are:

  • "px" — Pixels

  • "cm" — Centimeters

  • "in" — Inches

  • "mm" — Millimeters

  • "pc" — Picas

  • "pt" — Points

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

Example: "0.5in"

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Size of the bottom margin, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "1in" specifies 1 inch. Valid abbreviations are:

  • "px" — Pixels

  • "cm" — Centimeters

  • "in" — Inches

  • "mm" — Millimeters

  • "pc" — Picas

  • "pt" — Points

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

Example: "0.5in"

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

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

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

collapse all

import mlreportgen.dom.*;
doctype = "html";
d = Document("test",doctype);

p = Paragraph("Hello World");
p.Style = {Border("solid","red"), ...
   HAlign("center"),InnerMargin("12pt")};
append(d,p);

p = Paragraph("More Greetings");
p.Style = {Border("solid","blue"), ...
   HAlign("center"),InnerMargin("30pt")};

append(d,p);
close(d);
rptview("test",doctype);

Version History

Introduced in R2014b

See Also

Topics