PowerPoint.SlideLayoutCollection class
Representa a coleção de layouts fornecidos pelo Mestre de Slides para slides.
- Extends
Comentários
[ Conjunto de API: PowerPointApi 1.3 ]
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
get |
Obtém o número de layouts na coleção. |
get |
Obtém um layout usando sua ID exclusiva. |
get |
Obtém um layout usando seu índice baseado em zero na coleção. |
get |
Obtém um layout usando sua ID exclusiva. Se esse layout não existir, um objeto com uma |
load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
toJSON() | Substitui o método JavaScript |
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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: PowerPoint.SlideLayout[];
Valor da propriedade
Detalhes do método
getCount()
Obtém o número de layouts na coleção.
getCount(): OfficeExtension.ClientResult<number>;
Retornos
OfficeExtension.ClientResult<number>
O número de layouts na coleção.
Comentários
getItem(key)
Obtém um layout usando sua ID exclusiva.
getItem(key: string): PowerPoint.SlideLayout;
Parâmetros
- key
-
string
A ID do layout.
Retornos
O layout com a ID exclusiva. Se esse layout não existir, um erro será gerado.
Comentários
getItemAt(index)
Obtém um layout usando seu índice baseado em zero na coleção.
getItemAt(index: number): PowerPoint.SlideLayout;
Parâmetros
- index
-
number
O índice do layout na coleção.
Retornos
O layout no índice fornecido. Um erro será gerado se o índice estiver fora do intervalo.
Comentários
getItemOrNullObject(id)
Obtém um layout usando sua ID exclusiva. Se esse layout não existir, um objeto com uma isNullObject
propriedade definida como true será retornado. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getItemOrNullObject(id: string): PowerPoint.SlideLayout;
Parâmetros
- id
-
string
A ID do layout.
Retornos
O layout com a ID exclusiva.
Comentários
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.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;
Parâmetros
- options
-
PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Fornece opções para quais propriedades do objeto carregar.
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[]): PowerPoint.SlideLayoutCollection;
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
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.SlideLayoutCollection;
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
toJSON()
Substitui o método JavaScript toJSON()
para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify()
. (JSON.stringify
por sua vez, chama o toJSON
método do objeto que é passado para ele.) Considerando que o objeto original PowerPoint.SlideLayoutCollection
é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.SlideLayoutCollectionData
) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;
Retornos
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de