PowerPoint.TableColumnCollection class
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示表列的集合。
方法
add(index, count) | 向表添加一个或多个列。 |
delete |
从集合中删除指定的列。 |
get |
获取集合中的列数。 |
get |
使用集合中从零开始的索引获取列。 |
load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
toJSON() | 重写 JavaScript |
属性详细信息
context
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
context: RequestContext;
属性值
items
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取此集合中已加载的子项。
readonly items: PowerPoint.TableColumn[];
属性值
方法详细信息
add(index, count)
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
向表添加一个或多个列。
add(index?: number | null | undefined, count?: number | undefined): void;
参数
- index
-
number | null | undefined
可选。 指定添加新列的从零开始的索引。 从索引位置开始的现有列向右移动。 如果索引值未定义、null、-1 或大于表中的列数,则会在表的末尾添加新列。
- count
-
number | undefined
可选。 要添加的列数。 如果值未定义或为 0,则只添加一列。
返回
void
注解
deleteColumns(columns)
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
从集合中删除指定的列。
deleteColumns(columns: PowerPoint.TableColumn[]): void;
参数
- columns
表示要删除的列的 TableColumn
对象的数组。
返回
void
注解
getCount()
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取集合中的列数。
getCount(): OfficeExtension.ClientResult<number>;
返回
OfficeExtension.ClientResult<number>
集合中的列数。
注解
getItemAt(index)
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
使用集合中从零开始的索引获取列。
getItemAt(index: number): PowerPoint.TableColumn;
参数
- index
-
number
要检索的列的索引值,作为从零开始的索引。
返回
列对象。
注解
load(options)
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(options?: PowerPoint.Interfaces.TableColumnCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableColumnCollection;
参数
- options
-
PowerPoint.Interfaces.TableColumnCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
提供要加载对象的属性的选项。
返回
load(propertyNames)
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(propertyNames?: string | string[]): PowerPoint.TableColumnCollection;
参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableColumnCollection;
参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand
一个逗号分隔的字符串,指定要加载的导航属性。
返回
toJSON()
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
重写 JavaScript toJSON()
方法,以便在将 API 对象传递给 JSON.stringify()
时提供更有用的输出。
JSON.stringify
(,反过来,调用toJSON
传递给它的 对象的 方法。) 而原始PowerPoint.TableColumnCollection
对象是 API 对象,toJSON
该方法返回一个纯 JavaScript 对象, (类型为 PowerPoint.Interfaces.TableColumnCollectionData
) ,其中包含一个“items”数组,其中包含集合项中任何已加载属性的浅表副本。
toJSON(): PowerPoint.Interfaces.TableColumnCollectionData;