mlreportgen.ppt.TableEntry class

Package: mlreportgen.ppt
Superclasses:

Description

Table entry to include in a table row.

To add content to a table entry, append a character vector or one or more mlreportgen.ppt.Paragraph objects.

The row with the largest number of table entries determines the number of columns in the table if there are more table entries in the row than the number of rows specified in the mlreportgen.ppt.Table object constructor.

Construction

tableEntryObj = TableEntry() creates an empty table entry object.

Output Arguments

expand all

Table entry, returned as an mlreportgen.ppt.TableEntry object.

Properties

expand all

Default formatting for text appended to table entry, specified as a cell array of PPT format objects. You can specify these mlreportgen.ppt format objects:

  • BackgroundColor object

  • FontFamily object

  • FontSize object

  • Bold object

  • FontColor object

  • Italic object

  • Underline object

Child elements of this object, specified as a cell array of PPT objects. This property is read-only.

Parent of this object, specified as a PPT object. This property is read-only.

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

Tag for this PPT API object, specified as a character vector. 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.

Methods

Method

Purpose

append

Add content to table entry.

Examples

collapse all

Create a presentation.

import mlreportgen.ppt.*

slidesFile = 'myTableEntryPresentation.pptx';
slides = Presentation(slidesFile);

slide1 = add(slides,'Title and Table');

Create a table with three columns.

table1 = Table(3);

Create the first table row.

tr1 = TableRow();
tr1.Style = {Bold(true)};

Create three table entries for the first row.

te1tr1 = TableEntry();
p = Paragraph('first entry');
p.FontColor = 'red';
append(te1tr1,p);

te2tr1 = TableEntry();
append(te2tr1,'second entry');

te3tr1 = TableEntry();
te3tr1.Style = {FontColor('green')};
append(te3tr1,'third entry');

Append the table entries to the first row.

append(tr1,te1tr1);
append(tr1,te2tr1);
append(tr1,te3tr1);

Create the second table row.

tr2 = TableRow();

Create three table entries for the second row.

te1tr2 = TableEntry();
te1tr2.Style = {FontColor('red')};
p = Paragraph('first entry');
append(te1tr2,p);

te2tr2 = TableEntry();
append(te2tr2,'second entry');

te3tr2 = TableEntry();
te3tr2.Style = {FontColor('green')};
append(te3tr2,'third entry');

Append the table entries to the second row.

append(tr2,te1tr2);
append(tr2,te2tr2);
append(tr2,te3tr2);

Append the table rows to the table.

append(table1,tr1);
append(table1,tr2);

Use the mlreportgen.ppt.Slide.find method to find objects in the slide with the Name property set to Table. In the default PPT API template, the Title and Table layout slide has an object with the name Table.

contents = find(slide1,'Table');

Replace the table placeholder with table1.

replace(contents(1),table1);

Close the presentation to generate the output.

close(slides);

Open myTableEntryPresentation.pptx. On a Windows® platform, you can open the presentation in MATLAB®:

if ispc
    winopen(slidesFile);
end

Introduced in R2015b