Share via

Excel.GroupShapeCollection class

  • Ссылка
Пакет:
excel

Представляет коллекцию фигур внутри группы фигур.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
items

Получает загруженные дочерние элементы в этой коллекции.

Методы

getCount()

Возвращает количество фигур в группе фигур.
getItem(key)

Возвращает фигуру, используя ее имя или идентификатор.
getItemAt(index)

Получает фигуру на основе ее позиции в коллекции.
getItemOrNullObject(key)

Возвращает фигуру, используя ее имя или идентификатор. Если объект shape не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *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)

Возвращает фигуру, используя ее имя или идентификатор.

getItem(key: string): Excel.Shape;

Параметры

key

string

Имя или идентификатор извлекаемой фигуры.

Возвращаемое значение

Excel.Shape

Комментарии

[ Набор API: ExcelApi 1.9 ]

getItemAt(index)

Получает фигуру на основе ее позиции в коллекции.

getItemAt(index: number): Excel.Shape;

Параметры

index

number

Отсчитываемое от нуля значение индекса извлекаемого объекта.

Возвращаемое значение

Excel.Shape

Комментарии

[ Набор API: ExcelApi 1.9 ]

getItemOrNullObject(key)

Возвращает фигуру, используя ее имя или идентификатор. Если объект shape не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(key: string): Excel.Shape;

Параметры

key

string

Имя или идентификатор извлекаемой фигуры.

Возвращаемое значение

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