mlreportgen.ppt.TablePlaceholder Class

Namespace: mlreportgen.ppt

Placeholder for slide table

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

`Bold` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Font` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`ComplexScriptFont` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`FontColor` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`FontSize` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Italic` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Strike` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Subscript` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Superscript` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Underline` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`BackgroundColor` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Valign` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Name` — Placeholder name
character vector | string scalar

Placeholder name, specified as a character vector or string scalar.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: char | string

`X` — Upper-left x-coordinate position
`[]` (default) | character vector | string scalar

Upper-left x-coordinate position, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "5in" specifies five inches. Valid abbreviations are:

"px" — Pixels
"cm" — Centimeters
"in" — Inches
"mm" — Millimeters
"pc" — Picas
"pt" — Points

Note

When the PPT API creates an mlreportgen.ppt.TablePlaceholder object, this property value is specified in English Metric Units (EMU). If you set this property, you must use one of the units in the previous list.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: char | string

`Y` — Upper-left y-coordinate position
`[]` (default) | character vector | string scalar

Upper-left y-coordinate position, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "5in" specifies five inches. Valid abbreviations are:

"px" — Pixels
"cm" — Centimeters
"in" — Inches
"mm" — Millimeters
"pc" — Picas
"pt" — Points

Note

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: char | string

`Width` — Width of placeholder
`[]` (default) | character vector | string scalar

Width of the placeholder, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "5in" specifies five inches. 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

`Height` — Height of placeholder
`[]` (default) | character vector | string scalar

Height of the placeholder, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "5in" specifies five inches. 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

`Style` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`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

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

`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

`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

Methods

expand all

Public Methods

replace Replace table placeholder with table

Examples

collapse all

Replace Table Placeholder with Table

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 namespace 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:555:529'
                   Id: '555:529'

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:556:530'
                   Id: '556:530'

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'

Version History

Introduced in R2015b

mlreportgen.ppt.TablePlaceholder Class

Description

Class Attributes

Properties

Bold — This property is ignored not applicable

Attributes:

Font — This property is ignored not applicable

Attributes:

ComplexScriptFont — This property is ignored not applicable

Attributes:

FontColor — This property is ignored not applicable

Attributes:

FontSize — This property is ignored not applicable

Attributes:

Italic — This property is ignored not applicable

Attributes:

Strike — This property is ignored not applicable

Attributes:

Subscript — This property is ignored not applicable

Attributes:

Superscript — This property is ignored not applicable

Attributes:

Underline — This property is ignored not applicable

Attributes:

BackgroundColor — This property is ignored not applicable

Attributes:

Valign — This property is ignored not applicable

Attributes:

Name — Placeholder name character vector | string scalar

Attributes:

X — Upper-left x-coordinate position [] (default) | character vector | string scalar

Attributes:

Y — Upper-left y-coordinate position [] (default) | character vector | string scalar

Attributes:

Width — Width of placeholder [] (default) | character vector | string scalar

Attributes:

Height — Height of placeholder [] (default) | character vector | string scalar

Attributes:

Style — This property is ignored not applicable

Attributes:

Children — Children of this object cell array of PPT API objects

Attributes:

Parent — Parent of this object PPT API object

Attributes:

Id — Object identifier character vector | string scalar

Attributes:

Tag — Tag character vector | string scalar

Attributes:

Methods

Public Methods

Examples

Replace Table Placeholder with Table

Tips

Version History

See Also

Topics

`Bold` — This property is ignored
not applicable

`Font` — This property is ignored
not applicable

`ComplexScriptFont` — This property is ignored
not applicable

`FontColor` — This property is ignored
not applicable

`FontSize` — This property is ignored
not applicable

`Italic` — This property is ignored
not applicable

`Strike` — This property is ignored
not applicable

`Subscript` — This property is ignored
not applicable

`Superscript` — This property is ignored
not applicable

`Underline` — This property is ignored
not applicable

`BackgroundColor` — This property is ignored
not applicable

`Valign` — This property is ignored
not applicable

`Name` — Placeholder name
character vector | string scalar

`X` — Upper-left x-coordinate position
`[]` (default) | character vector | string scalar

`Y` — Upper-left y-coordinate position
`[]` (default) | character vector | string scalar

`Width` — Width of placeholder
`[]` (default) | character vector | string scalar

`Height` — Height of placeholder
`[]` (default) | character vector | string scalar

`Style` — This property is ignored
not applicable

`Children` — Children of this object
cell array of PPT API objects

`Parent` — Parent of this object
PPT API object

`Id` — Object identifier
character vector | string scalar

`Tag` — Tag
character vector | string scalar