Edit

Share via

PowerPoint.TableCell class

  • Reference
Package:
powerpoint

Represents a table.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi 1.8 ]

Properties

columnCount

Gets the number of table columns this cell spans across. Will be greater than or equal to 1.
columnIndex

Gets the zero-based column index of the cell within the table.
context

The request context associated with the object. This connects the add-in's process to the Office host application's process.
rowCount

Gets the number of table rows this cell spans across. Will be greater than or equal to 1.
rowIndex

Gets the zero-based row index of the cell within the table.
text

Specifies the text content of the table cell.

Methods

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original PowerPoint.TableCell object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.TableCellData) that contains shallow copies of any loaded child properties from the original object.

Property Details

columnCount

Gets the number of table columns this cell spans across. Will be greater than or equal to 1.

readonly columnCount: number;

Property Value

number

Remarks

[ API set: PowerPointApi 1.8 ]

columnIndex

Gets the zero-based column index of the cell within the table.

readonly columnIndex: number;

Property Value

number

Remarks

[ API set: PowerPointApi 1.8 ]

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

PowerPoint.RequestContext

rowCount

Gets the number of table rows this cell spans across. Will be greater than or equal to 1.

readonly rowCount: number;

Property Value

number

Remarks

[ API set: PowerPointApi 1.8 ]

rowIndex

Gets the zero-based row index of the cell within the table.

readonly rowIndex: number;

Property Value

number

Remarks

[ API set: PowerPointApi 1.8 ]

text

Specifies the text content of the table cell.

text: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.8 ]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: PowerPoint.Interfaces.TableCellLoadOptions): PowerPoint.TableCell;

Parameters

options
PowerPoint.Interfaces.TableCellLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.TableCell

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): PowerPoint.TableCell;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

PowerPoint.TableCell

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.TableCell;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

PowerPoint.TableCell

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original PowerPoint.TableCell object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.TableCellData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.TableCellData;

Returns

PowerPoint.Interfaces.TableCellData