mlreportgen.ppt.ColSpec Class

Namespace: mlreportgen.ppt

Formatting for table column

Description

Use an object of the mlreportgen.ppt.ColSpec class to format the content of a table column in a PPT API presentation. Specify formats by setting the format properties, adding format objects to the Style property, or a combination of the two. See Presentation Formatting Approaches.

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

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Creation

Description

colSpecObj = mlreportgen.ppt.ColSpec creates an empty table column specification object.

colSpecObj = mlreportgen.ppt.ColSpec(colWidth) sets the Width property to colWidth.

Properties

Width — Column width

[] (default) | character vector | string scalar

Table column width, specified as a character vector or string scalar that contains a number followed by a unit of measurement. For example, "2in" specifies 2 inches. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

Example: "2in"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Bold — Whether to use bold for text

[] (default) | true or 1 | false or 0

Option to use bold for text, specified as a numeric or logical 1 (true) or 0 (false). To make text bold, set this property to true or 1.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

Font — Font family for text

[] (default) | character vector | string scalar

Font family for the text, specified as a character vector or string scalar. Specify a font that appears in the font list in Microsoft^® PowerPoint^®. To see the font list, in PowerPoint, on the Home tab, in the Font group, click the arrow to the right of the font.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

ComplexScriptFont — Font family for complex scripts

[] (default) | character vector | string scalar

Font family for complex scripts, specified as a character vector or string scalar. Specify a font family to use when substituting in a locale that requires a complex script, such as Arabic or Asian, to render text.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

FontColor — Font color for text

[] (default) | character vector | string scalar

Font color for the text, specified as a character vector or string scalar that contains a CSS color name or hexadecimal RGB value.

• To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://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.

Example: "blue"

Example: "#0000ff"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

FontSize — Font size of text

[] (default) | character vector | string scalar

Font size of the text, specified as a character vector or string scalar that contains a number followed by a unit of measurement. For example, "11pt" specifies 11 points. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Italic — Whether to use italic for text

[] (default) | true or 1 | false or 0

Whether to use italic for the text, specified as a numeric or logical 1 (true) or 0 (false). If Italic is true or 1, text renders in italic. If Italic is false or 0, text renders as straight.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

Strike — Strikethrough style for text

[] (default) | "single" | "none" | "double"

Strikethrough style for the text, specified as one of these values:

• "single" — Single horizontal line

• "none" —No strikethrough line

• "double" — Double horizontal line

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Subscript — Whether to display text as a subscript

[] (default) | true or 1 | false or 0

Whether to display the text as a subscript, specified as a numeric or logical 1 (true) or 0 (false). If Subscript is true or 1, text renders as a subscript. If Subscript is false or 0, text renders as regular text.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

Superscript — Whether to display text as a superscript

[] (default) | true or 1 | false or 0

Whether to display the text as a superscript, specified as a numeric or logical 1 (true) or 0 (false). If Superscript is true or 1, text renders as a superscript. If Superscript is false or 0, text renders as regular text.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

Underline — Underline style for text

[] (default) | "single" | "double" | ... | ...

Underline style for the text, specified as one of these values:

Value	Description
"single"	Single underline
"double"	Double underline
"heavy"	Thick underline
"words"	Only words underlined (not spaces)
"dotted"	Dotted underline
"dottedheavy"	Thick, dotted underline
"dash"	Dashed underline
"dashheavy"	Thick, dashed underline
"dashlong"	Long, dashed underline
"dashlongheavy"	Thick, long, dashed underline
"dotdash"	Dot-dash underline
"dotdashheavy"	Thick, dot-dash underline
"dotdotdash"	Dot-dot-dash underline
"dotdotdashheavy"	Thick, dot-dot-dash underline
"wavy"	Wavy underline
"wavyheavy"	Thick, wavy underline
"wavydouble"	Wavy, double underline
"none"	No underline

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

BackgroundColor — Background color

[] (default) | character vector | string scalar

Background color that contains a CSS color name or a hexadecimal RGB value, specified as a character vector or string scalar.

• To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://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.

Note

Setting the BackgroundColor property adds a mlreportgen.ppt.BackgroundColor format object to the Style property. Setting the BackgroundColor property to an empty value removes the object.

Example: "blue"

Example: "#0000ff"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

HAlign — Horizontal alignment of content

[] (default) | "center" | "left" | ...

Horizontal alignment of the content, specified as a character vector or string scalar. Specify one of the values in the table.

Value	Description
"center"	Centered
"left"	Left-justified
"right"	Right-justified
"justified"	Left and right-justified, spacing words evenly
"distributed"	Left and right-justified, spacing letters evenly
"thaiDistributed"	Left and right-justified Thai text, spacing characters evenly
"justifiedLow"	Justification for Arabic text

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

VAlign — Vertical alignment of content

[] (default) | "top" | "bottom" | ...

Vertical alignment of the content, specified as one of these values:

Value	Description
"top"	Vertically aligned to the top
"bottom"	Vertically aligned to the bottom of the table entry
"middle"	Vertically aligned to the middle of the table entry
"topCentered"	Vertically aligned to the top and horizontally aligned to the center of the table entry
"bottomCentered"	Vertically aligned to the bottom and horizontally aligned to the center of the table entry
"middleCentered"	Vertically aligned to the middle and horizontally aligned to the center of the table entry

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

TextOrientation — Orientation of text

[] (default) | "horizontal" | "down" | "up"

Orientation of the text, specified as one of these values:

Value	Description
"horizontal"	Text orientation is horizontal.
"down"	Text orientation is vertical, with the content rotated 90 degrees, clockwise.
"up"	Text orientation is vertical, with the content rotated 90 degrees, counterclockwise.

See Specify Orientation of Column Text.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Style — Column formatting

cell array of PPT format objects

Column formatting, specified as a cell array of PPT API format objects. Formats that do not apply to a ColSpec object are ignored.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: cell

Parent — Parent of this object

PPT API object

Parent of this object, specified as a PPT API object. A PPT API object must only have one parent.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Children — Children of this object

cell array of PPT API objects

Child elements of this object, specified as a cell array of PPT API objects.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Data Types: cell

Tag — Tag

character vector | string scalar

Tag, specified as a character vector or string scalar. The PPT 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 PPT API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Examples

Specify Table Column Formatting

Create a presentation and add a slide.

import mlreportgen.ppt.*

ppt = Presentation("myColSpec.pptx");
open(ppt);
slide = add(ppt,"Title and Content");

Create a table. Specify the width and background color of the first two columns of the table.

t = Table(magic(12));
t.Style = {HAlign("center")};

colSpecs(2) = ColSpec("2in");
colSpecs(1) = ColSpec("1in");
colSpecs(1).BackgroundColor = "red";
colSpecs(2).BackgroundColor = "green";
t.ColSpecs = colSpecs;

Add the table to the slide.

replace(slide,"Content",t);

Close and view the presentation.

close(ppt);
rptview(ppt);

Specify Orientation of Column Text

Create a presentation.

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

Add a slide to the presentation.

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

Create a table.

table = Table({"Col 1","Col 2";"entry 1","entry 2"});
table.Height = "2in";
table.Style = [table.Style {VAlign("middleCentered")}];

Define the formatting for the table columns by using mlreportgen.ppt.ColSpec objects. Specify that the orientation of the text in the first column is vertical, rotated 90 degrees, counterclockwise. Specify that the orientation of the text in the second column is vertical, rotated 90 degrees, clockwise.

colSpecs(1) = ColSpec("1in");
colSpecs(1).TextOrientation = "up";
colSpecs(2) = ColSpec("1in");
colSpecs(2).TextOrientation = "down";

Assign the ColSpec objects to the Table object.

table.ColSpecs = colSpecs;

Add the table to the slide.

replace(slide,"Table",table);

Close and view the presentation.

close(ppt);
rptview(ppt);

Version History

Introduced in R2015b