mlreportgen.ppt.TableStyleOptions class

Package: mlreportgen.ppt
Superclasses:

Stripe table rows and columns

Description

Specifies whether to format table rows and columns. Before you use TableStyleOptions, specify the table style using the StyleName property on the Table object you want to apply the options to. The table style determines the formatting of the table, for example, the color of the banding and first- and last-column emphasis.

Construction

tableStyles = TableStyleOptions() creates a TableStyleOptions object. This object uses the properties of the table style assigned to the StyleName property of the table you assign the properties to. The table uses the TableStyleOption object only if the associated table sets the StyleName property.

Output Arguments

tableStyles — Table style property options

mlreportgen.ppt.TableStyleOptions object

Table style property options, returned as an mlreportgen.ppt.TableStyleOptions object.

Properties

BandedColumns — Alternating color for columns

true | false

Alternating color (banding) for columns, specified as:

• true — Colors alternate for columns.

• false — Columns use same color.

BandedRows — Alternating color (banding) for rows

true | false

Alternating color for rows, specified as:

• true — Colors alternate for rows.

• false — Rows use same color.

FirstColumn — Emphasis for first column in table

true | false

Emphasis for first column in table, specified as:

• true — First column uses emphasis styling, e.g., stronger color, emphasized font.

• false — Regular styling on first column.

FirstRow — Emphasis for first row of table

true | false

Emphasis for first row of table, specified as:

• true — First row uses emphasis styling, e.g., stronger color, emphasized font.

• false — Regular styling on first row.

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.

LastColumn — Emphasis for last column in table

true | false

Emphasis for last column in table, specified as:

• true — Last column uses emphasis styling, e.g., stronger color, emphasized font.

• false — Regular styling on last column.

LastRow — Emphasis for last row of table

true | false

Emphasis for last row of table, specified as:

• true — Last row uses emphasis styling, e.g., stronger color, emphasized font.

• false — Regular styling on last row.

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

Style a Table

This example shows how to control the formatting of a table based on the Medium Style 2 - Accent 1 table style in the default PPT template. Change the values of each of the styling properties from false to true, or the reverse, to understand their effects.

import mlreportgen.ppt.* 
slidesFile = 'myppt.pptx'; 
slides = Presentation(slidesFile); 
add(slides,'Title and Content'); 

% Create the tableand specify the table style name
table = Table(magic(5)); 
table.StyleName = 'Medium Style 2 - Accent 1'; 

% Create the format and set the properties
tblStyle = TableStyleOptions(); 
tblStyle.FirstRow = false; 
tblStyle.LastRow = false; 
tblStyle.FirstColumn = true; 
tblStyle.LastColumn = false; 
tblStyle.BandedRows = true; 
tblStyle.BandedColumns = false; 

% Apply the formatting to the table
table.Style = {tblStyle}; 

% Add the table to the slide
% Generate and display the presentation
replace(slides,'Content',table); 
close(slides); 

if ispc 
winopen(slides.OutputPath); 
end