mlreportgen.ppt.TablePlaceholder class

Package: mlreportgen.ppt

Placeholder for slide table

expand all in page

Description

An object of the mlreportgen.ppt.TablePlaceholder class represents a table placeholder in a slide.

The PPT API creates a TablePlaceholder object when you add a slide to a presentation and the slide layout has a table placeholder. In the default PPT API, the Title and Table layout has a table placeholder.

To find a TablePlaceholder object, use the find method of the slide that contains the table placeholder. To replace the table placeholder with a table, use the replace method of the TablePlaceholder object. The replace method replaces the TablePlaceholder object with an mlreportgen.ppt.Table object.

You can use the properties of a TablePlaceholder object to specify the position or size of the replacement table. However, the text formatting properties are ignored. To format the table that you use to replace a TablePlaceholder object, use the properties of the Table object.

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

Class Attributes

HandleCompatible
true
ConstructOnLoad
true

For information on class attributes, see Class Attributes.

Properties

expand all

This property is ignored.

This property is ignored.

This property is ignored.

This property is ignored.

This property is ignored.

This property is ignored.

This property is ignored.

This property is ignored.

This property is ignored.

This property is ignored.

This property is ignored.

This property is ignored.

Table placeholder name, specified as a character vector or string scalar.

Upper left x-coordinate of the position of the table placeholder in the slide, specified as a character vector or string scalar that consists of a number followed by a unit of measurement. For example, '5in' specifies 5 inches. Valid abbreviations are:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

Upper left y-coordinate of the position of the table placeholder in the slide, specified as a character vector or string scalar that consists of a number followed by a unit of measurement. For example, '5in' specifies 5 inches. Valid abbreviations are:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

Width of the table placeholder, specified as a character vector or string scalar that consists of a number followed by an abbreviation for a unit of measurement. For example, '5in' specifies five inches. Valid abbreviations are:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

Height of the table placeholder, specified as a character vector or string scalar that consists of a number followed by an abbreviation for a unit of measurement. For example, '5in' specifies five inches. Valid abbreviations are:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

This property is ignored.

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 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 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.

Methods

expand all

Examples

collapse all

Open Live Script

Add a Title and Table slide to a presentation and then replace the title and table placeholders with your own title and table.

Import the PPT package so that you do not have to use long, fully qualified names for the PPT API classes.

import mlreportgen.ppt.*

Create a presentation.

ppt = Presentation("myTablePlaceholderPresentation.pptx");
open(ppt);

Add a slide that has a Title and Table layout.

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

Use the find method of the slide object to find the placeholder object that has the name Title.

titlePlaceholderObj = find(slide,"Title")
titlePlaceholderObj = 
  TextBoxPlaceholder with properties:

                 Bold: []
                 Font: []
    ComplexScriptFont: []
            FontColor: []
             FontSize: []
               Italic: []
               Strike: []
            Subscript: []
          Superscript: []
            Underline: []
      BackgroundColor: []
               VAlign: []
                 Name: 'Title'
                    X: []
                    Y: []
                Width: []
               Height: []
                Style: []
             Children: []
               Parent: [1×1 mlreportgen.ppt.Slide]
                  Tag: 'ppt.TextBoxPlaceholder:30:96'
                   Id: '30:96'

The find method returns an mlreportgen.ppt.TextBoxPlaceholder object.

Replace the placeholder content with the title text.

replace(titlePlaceholderObj,"Fourth-Order Magic Square");

Use the find method of the slide object to find the placeholder object that has the name Table.

tablePlaceholderObj = find(slide,"Table")
tablePlaceholderObj = 
  TablePlaceholder with properties:

                 Bold: []
                 Font: []
    ComplexScriptFont: []
            FontColor: []
             FontSize: []
               Italic: []
               Strike: []
            Subscript: []
          Superscript: []
            Underline: []
      BackgroundColor: []
               VAlign: []
                 Name: 'Table'
                    X: []
                    Y: []
                Width: []
               Height: []
                Style: []
             Children: []
               Parent: [1×1 mlreportgen.ppt.Slide]
                  Tag: 'ppt.TablePlaceholder:31:97'
                   Id: '31:97'

The find method returns an mlreportgen.ppt.TablePlaceholder object.

Replace the table placeholder with a table for a fourth-order magic square.

replace(tablePlaceholderObj,Table(magic(4)));

Close and view the presentation

close(ppt);
rptview(ppt);

Here is the slide in the generated presentation:

Tips

  • When you replace a table placeholder with a table in a presentation and then use the presentation as a template for a new presentation, the PPT API creates an mlreportgen.ppt.TemplateTable object for the table in the new presentation. See Add or Replace a Table.

  • To see the placeholder objects that the PPT API creates for a slide object, view the Children property of the slide. For example, when you add a Title and Table slide to a presentation, the Children property is an array that contains an mlreportgen.ppt.TextBoxPlaceholder object and an mlreportgen.ppt.TablePlaceholder object.

    ppt = mlreportgen.ppt.Presentation("test.pptx");
open(ppt);
slide = add(ppt,"Title and Table");
slide.Children(1)

    ans = 

  TextBoxPlaceholder with properties:

                 Bold: []
                 Font: []
    ComplexScriptFont: []
            FontColor: []
             FontSize: []
               Italic: []
               Strike: []
            Subscript: []
          Superscript: []
            Underline: []
      BackgroundColor: []
               VAlign: []
                 Name: 'Title'
                    X: []
                    Y: []
                Width: []
               Height: []
                Style: []
             Children: []
               Parent: [1×1 mlreportgen.ppt.Slide]
                  Tag: 'ppt.TextBoxPlaceholder:6:7'
                   Id: '6:7'

    slide.Children(2)

    ans = 

  TablePlaceholder with properties:

                 Bold: []
                 Font: []
    ComplexScriptFont: []
            FontColor: []
             FontSize: []
               Italic: []
               Strike: []
            Subscript: []
          Superscript: []
            Underline: []
      BackgroundColor: []
               VAlign: []
                 Name: 'Table'
                    X: []
                    Y: []
                Width: []
               Height: []
                Style: []
             Children: []
               Parent: [1×1 mlreportgen.ppt.Slide]
                  Tag: 'ppt.TablePlaceholder:7:8'
                   Id: '7:8'

See Also

| | | | |

Topics

Introduced in R2015b

MATLAB Report Generator Documentation

Support