PowerPoint.ShapeScopedCollection class

  • Referência
Pacote:
powerpoint

Representa uma coleção de formas.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: PowerPointApi 1.5 ]

Propriedades

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
items

Obtém os itens filhos carregados nesta coleção.

Métodos

getCount()

Obtém o número de formas na coleção.
getItem(key)

Obtém uma forma usando sua ID exclusiva. Um erro será gerado se a forma não existir.
getItemAt(index)

Obtém uma forma usando seu índice baseado em zero na coleção. Um erro será gerado se o índice estiver fora do intervalo.
getItemOrNullObject(id)

Obtém uma forma usando sua ID exclusiva. Se essa forma não existir, um objeto com uma isNullObject propriedade definida como true será retornado.
load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
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(propertyNamesAndPaths)

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

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original PowerPoint.ShapeScopedCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.ShapeScopedCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

PowerPoint.RequestContext

items

Obtém os itens filhos carregados nesta coleção.

readonly items: PowerPoint.Shape[];

Valor da propriedade

PowerPoint.Shape[]

Detalhes do método

getCount()

Obtém o número de formas na coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

O número de formas na coleção.

Comentários

[ Conjunto de API: PowerPointApi 1.5 ]

getItem(key)

Obtém uma forma usando sua ID exclusiva. Um erro será gerado se a forma não existir.

getItem(key: string): PowerPoint.Shape;

Parâmetros

key

string

A ID da forma.

Retornos

PowerPoint.Shape

A forma com a ID exclusiva. Se essa forma não existir, um erro será gerado.

Comentários

[ Conjunto de API: PowerPointApi 1.5 ]

getItemAt(index)

Obtém uma forma usando seu índice baseado em zero na coleção. Um erro será gerado se o índice estiver fora do intervalo.

getItemAt(index: number): PowerPoint.Shape;

Parâmetros

index

number

O índice da forma na coleção.

Retornos

PowerPoint.Shape

A forma no índice determinado. Um erro será gerado se o índice estiver fora do intervalo.

Comentários

[ Conjunto de API: PowerPointApi 1.5 ]

getItemOrNullObject(id)

Obtém uma forma usando sua ID exclusiva. Se essa forma não existir, um objeto com uma isNullObject propriedade definida como true será retornado.

getItemOrNullObject(id: string): PowerPoint.Shape;

Parâmetros

id

string

A ID da forma.

Retornos

PowerPoint.Shape

A forma com a ID exclusiva. Se essa forma não existir, um objeto com uma isNullObject propriedade definida como true será retornado.

Comentários

[ Conjunto de API: PowerPointApi 1.5 ]

load(options)

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

load(options?: PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeScopedCollection;

Parâmetros

options

PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

PowerPoint.ShapeScopedCollection

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[]): PowerPoint.ShapeScopedCollection;

Parâmetros

propertyNames

string | string[]

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

Retornos

PowerPoint.ShapeScopedCollection

load(propertyNamesAndPaths)

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

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

Parâmetros

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

PowerPoint.ShapeScopedCollection

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original PowerPoint.ShapeScopedCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.ShapeScopedCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;

Retornos

PowerPoint.Interfaces.ShapeScopedCollectionData