mlreportgen.ppt.Border class

Package: mlreportgen.ppt

Border of a table or table entry

Description

Use an mlreportgen.ppt.Border format object to customize the border of a table or table entry in a PPT API presentation.

Note

A conflict occurs if a border segment is shared by two table entries. For a conflicting horizontal border segment, Microsoft^® PowerPoint^® ignores the formats specified by the entry on the bottom. For a conflicting vertical border segment, PowerPoint ignores the formats specified by the entry on the right.

The mlreportgen.ppt.Border class is a handle class.

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Creation

Description

mlreportgen.ppt.Border() creates an empty mlreportgen.ppt.Border object. By default, PowerPoint renders table borders as thin, solid, black lines. Use the object properties to specify a different border width, style, or color.

mlreportgen.ppt.Border(style) sets the Style, TopStyle, BottomStyle, LeftStyle, and RightStyle properties to the value of style.

mlreportgen.ppt.Border(style,color) also sets the Color, TopColor, BottomColor, LeftColor, and RightColor properties to the value of color.

mlreportgen.ppt.Border(style,color,width) also sets the Width, TopWidth, BottomWidth, LeftWidth, and RightWidth properties to the value of width.

Properties

Style — Default style of border segments

[] (default) | 'none' | 'solid' | 'dot' | ...

Default style of border segments, specified as a string scalar or character vector. Specify one of these values:

• 'none'

• 'solid'

• 'dot'

• 'dash'

• 'largeDash'

• 'dashDot'

• 'largeDashDot'

• 'largeDashDotDot'

• 'systemDash'

• 'systemDot'

• 'systemDashDot'

• 'systemDashDotDot'

Color — Default color of border segments

[] (default) | character vector | string scalar

Default color of border segments, specified as a character vector or string scalar that consists of a CSS color name or hexadecimal RGB value.

• For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, '#0000ff' specifies blue.

Width — Default width of border segments

[] (default) | character vector | string scalar

Default width of border segments, specified as a character vector or string scalar that consists of a number followed by an abbreviation for a unit of measurement. For example, '3pt' specifies three points. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

TopStyle — Style of top border segment

[] (default) | 'none' | 'solid' | 'dot' | ...

Style of the top border segment, specified as a character vector or string scalar. Specify one of these values:

• 'none'

• 'solid'

• 'dot'

• 'dash'

• 'largeDash'

• 'dashDot'

• 'largeDashDot'

• 'largeDashDotDot'

• 'systemDash'

• 'systemDot'

• 'systemDashDot'

• 'systemDashDotDot'

TopColor — Color of top border segment

[] (default) | character vector | string scalar

Color of the top border segment, specified as a character vector or string scalar that consists of a CSS color name or hexadecimal RGB value.

• For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, '#0000ff' specifies blue.

TopWidth — Width of top border segment

[] (default) | character vector | string scalar

Width of the top border segment, specified as a character vector or string scalar that consists of a number followed by an abbreviation for a unit of measurement. For example, '3pt' specifies three points. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

BottomStyle — Style of bottom border segment

[] (default) | 'none' | 'solid' | 'dot' | ...

Style of the bottom border segment, specified as a character vector or string scalar. Specify one of these values:

• 'none'

• 'solid'

• 'dot'

• 'dash'

• 'largeDash'

• 'dashDot'

• 'largeDashDot'

• 'largeDashDotDot'

• 'systemDash'

• 'systemDot'

• 'systemDashDot'

• 'systemDashDotDot'

BottomColor — Color of bottom border segment

[] (default) | character vector | string scalar

Color of the bottom border segment, specified as a character vector or string scalar that consists of a CSS color name or hexadecimal RGB value.

• For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, '#0000ff' specifies blue.

BottomWidth — Width of bottom border segment

[] (default) | character vector | string scalar

Width of the bottom border segment, specified as a character vector or string scalar that consists of a number followed by an abbreviation for a unit of measurement. For example, '3pt' specifies three points. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

LeftStyle — Style of left border segment

[] (default) | 'none' | 'solid' | 'dot' | ...

Style of the left border segment, specified as a character vector or string scalar. Specify one of these values:

• 'none'

• 'solid'

• 'dot'

• 'dash'

• 'largeDash'

• 'dashDot'

• 'largeDashDot'

• 'largeDashDotDot'

• 'systemDash'

• 'systemDot'

• 'systemDashDot'

• 'systemDashDotDot'

LeftColor — Color of left border segment

[] (default) | character vector | string scalar

Color of the left border segment, specified as a character vector or string scalar that consists of a CSS color name or hexadecimal RGB value.

• For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, '#0000ff' specifies blue.

LeftWidth — Width of left border segment

[] (default) | character vector | string scalar

Width of the left border segment, specified as a character vector or string scalar that consists of a number followed by an abbreviation for a unit of measurement. For example, '3pt' specifies three points. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

RightStyle — Style of right border segment

[] (default) | 'none' | 'solid' | 'dot' | ...

Style of the right border segment, specified as a character vector or string scalar. Specify one of these values:

• 'none'

• 'solid'

• 'dot'

• 'dash'

• 'largeDash'

• 'dashDot'

• 'largeDashDot'

• 'largeDashDotDot'

• 'systemDash'

• 'systemDot'

• 'systemDashDot'

• 'systemDashDotDot'

RightColor — Color of right border segment

character vector | string scalar

Color of the right border segment, specified as a character vector or string scalar that consists of a CSS color name or hexadecimal RGB value.

• For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, '#0000ff' specifies blue.

RightWidth — Width of right border segment

[] (default) | character vector | string scalar

Width of the right border segment, specified as a character vector or string scalar that consists of a number followed by an abbreviation for a unit of measurement. For example, '3pt' specifies three points. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Id — ID for this PPT API object

character vector | string scalar

ID for this PPT API object, specified as a character vector or string scalar. A session-unique ID is generated as part of object creation. You can specify an ID to replace the generated ID.

Tag — Tag for this PPT API object

character vector | string scalar

Tag for this PPT API object, specified as a character vector or string scalar. A session-unique tag is generated 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 presentation generation.

Examples

Customize the Border of a Table in a Presentation

To customize the border or a border segment of a table or table entry in a PPT API presentation, specify the border style, color, and width in an mlreportgen.ppt.Border format object and add the object to the Style property of an mlreportgen.ppt.Table or mlreportgen.ppt.TabeEntry object. This example specifies that the bottom border of the entry in the second row and second column is dashed, red, and has a width of three points.

Create a presentation.

import mlreportgen.ppt.*
ppt = Presentation("myTEBorders.pptx");
open(ppt);

Add a slide to the presentation.

slide = add(ppt,"Title and Table");

Create a table.

t = Table(magic(3));

Create a border object to customize the bottom border segment.

border = Border();
border.BottomStyle = "dash";
border.BottomColor = "red";
border.BottomWidth = "3pt";

Apply the custom border to the entry in the second column and second row.

tr2te2 = t.entry(2,2);
tr2te2.Style = [tr2te2.Style {border}];

Add a title and the table to the slide.

replace(slide,"Title","Table entry with custom borders");
replace(slide,"Table",t);

Close and view the presentation.

close(ppt);
rptview(ppt);

Here is the table in the generated presentation:

Version History

Introduced in R2020a