Edit

Share via

PowerPoint.TableRow class

  • Reference
Package:
powerpoint

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents a row in a table.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Properties

context

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

Retrieves the current height of the row in points.
height

Specifies the height of the row in points. If the set row height is less than the minimum height, the row height will be increased to the minimum height.
rowIndex

Returns the index number of the row within the rows collection of the table. Zero-indexed.

Methods

delete()

Deletes the row.
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.TableRow object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.TableRowData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

currentHeight

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Retrieves the current height of the row in points.

readonly currentHeight: number;

Property Value

number

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

height

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the height of the row in points. If the set row height is less than the minimum height, the row height will be increased to the minimum height.

height: number;

Property Value

number

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

rowIndex

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the index number of the row within the rows collection of the table. Zero-indexed.

readonly rowIndex: number;

Property Value

number

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Method Details

delete()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Deletes the row.

delete(): void;

Returns

void

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

load(options)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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.TableRowLoadOptions): PowerPoint.TableRow;

Parameters

options
PowerPoint.Interfaces.TableRowLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.TableRow

load(propertyNames)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.TableRow

load(propertyNamesAndPaths)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

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

toJSON()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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.TableRow object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.TableRowData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.TableRowData;

Returns

PowerPoint.Interfaces.TableRowData