Excel.GroupShapeCollection class

包:

excel

表示形状组中的形状集合。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.9 ]

属性

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

方法

getCount()	返回形状组中的形状数量。
getItem(key)	使用形状的名称或 ID 获取形状。
getItemAt(index)	根据其在集合中的位置获取形状。
getItemOrNullObject(key)	使用形状的名称或 ID 获取形状。 如果形状对象不存在，则此方法返回一个对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.GroupShapeCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.GroupShapeCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

items

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

readonly items: Excel.Shape[];

属性值

Excel.Shape[]

方法详细信息

getCount()

返回形状组中的形状数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

[ API 集：ExcelApi 1.9 ]

getItem(key)

使用形状的名称或 ID 获取形状。

getItem(key: string): Excel.Shape;

参数

key

string

要检索的形状的名称或 ID。

返回

Excel.Shape

注解

[ API 集：ExcelApi 1.9 ]

getItemAt(index)

根据其在集合中的位置获取形状。

getItemAt(index: number): Excel.Shape;

参数

index

number

要检索的对象的从零开始的索引值。

返回

Excel.Shape

注解

[ API 集：ExcelApi 1.9 ]

getItemOrNullObject(key)

使用形状的名称或 ID 获取形状。 如果形状对象不存在，则此方法返回一个对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getItemOrNullObject(key: string): Excel.Shape;

参数

key

string

要检索的形状的名称或 ID。

返回

Excel.Shape

注解

[ API 集：ExcelApi 1.14 ]

load(options)

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

load(options?: Excel.Interfaces.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.GroupShapeCollection;

参数

options

Excel.Interfaces.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

返回

Excel.GroupShapeCollection

load(propertyNames)

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

load(propertyNames?: string | string[]): Excel.GroupShapeCollection;

参数

propertyNames

string | string[]

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

返回

Excel.GroupShapeCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.GroupShapeCollection;

参数

propertyNamesAndPaths

OfficeExtension.LoadOption

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

返回

Excel.GroupShapeCollection

toJSON()

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

toJSON(): Excel.Interfaces.GroupShapeCollectionData;

返回

Excel.Interfaces.GroupShapeCollectionData