Excel.GroupShapeCollection interface

Representa a coleção Shape dentro de um grupo de formas.

Métodos

_GetItem(shapeId)

Retorna uma forma identificada pela ID da forma.

getCount()

Retorna o número de formas no grupo de forma.

getItem(key)

Obtém uma forma usando seu nome ou ID.

getItemAt(index)

Obtém uma forma com base em sua posição na coleção.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

Detalhes do método

_GetItem(shapeId)

Retorna uma forma identificada pela ID da forma.

_GetItem(shapeId: string): Shape;

Parâmetros

shapeId
string

O identificador da forma.

Retornos

getCount()

Retorna o número de formas no grupo de forma.

getCount(): ClientResult<number>;

Retornos

ClientResult<number>

getItem(key)

Obtém uma forma usando seu nome ou ID.

getItem(key: string): Shape;

Parâmetros

key
string

O nome ou a ID da forma a ser recuperada.

Retornos

getItemAt(index)

Obtém uma forma com base em sua posição na coleção.

getItemAt(index: number): Shape;

Parâmetros

index
number

O valor de índice baseado em zero do objeto a ser recuperado.

Retornos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void