PowerPoint.TableRowCollection class

包:

powerpoint

表示表行的集合。

扩展

OfficeExtension.ClientObject

注解

API 集：PowerPointApi 1.9

使用方

• PowerPoint.Table： 行

属性

context	与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
items	获取此集合中已加载的子项。

方法

add(index, count)	向表中添加一行或多行。
deleteRows(rows)	从集合中删除指定的行。
getCount()	获取集合中的行数。
getItemAt(index)	使用集合中从零开始的索引获取行。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 PowerPoint.TableRowCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.TableRowCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

属性详细信息

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

PowerPoint.RequestContext

items

获取此集合中已加载的子项。

readonly items: PowerPoint.TableRow[];

属性值

PowerPoint.TableRow[]

方法详细信息

add(index, count)

向表中添加一行或多行。

add(index?: number | null | undefined, count?: number | undefined): void;

参数

index

number | null | undefined

可选。 指定添加新行的位置从零开始的索引。 从索引位置开始的现有行将下移。 如果索引值未定义、null、-1 或大于表中的行数，则新行将添加到表的末尾。

count

number | undefined

可选。 要添加的行数。 如果值未定义或为 0，则只添加一行。

返回

void

注解

API 集：PowerPointApi 1.9

deleteRows(rows)

从集合中删除指定的行。

deleteRows(rows: PowerPoint.TableRow[]): void;

参数

rows

PowerPoint.TableRow[]

表示要删除的行的对象数组 TableRow 。

返回

void

注解

API 集：PowerPointApi 1.9

getCount()

获取集合中的行数。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

集合中的行数。

注解

API 集：PowerPointApi 1.9

getItemAt(index)

使用集合中从零开始的索引获取行。

getItemAt(index: number): PowerPoint.TableRow;

参数

index

number

要检索的行的索引值，作为从零开始的索引。

返回

PowerPoint.TableRow

行对象。

注解

API 集：PowerPointApi 1.9

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: PowerPoint.Interfaces.TableRowCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableRowCollection;

参数

options

PowerPoint.Interfaces.TableRowCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

为要加载的对象属性提供选项。

返回

PowerPoint.TableRowCollection

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

PowerPoint.TableRowCollection

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableRowCollection;

参数

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

PowerPoint.TableRowCollection

toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 PowerPoint.TableRowCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.TableRowCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

toJSON(): PowerPoint.Interfaces.TableRowCollectionData;

返回

PowerPoint.Interfaces.TableRowCollectionData