PowerPoint.SlideCollection class
Representa a coleção de slides na apresentação.
- Extends
Comentários
[ Conjunto de API: PowerPointApi 1.2 ]
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 slides na coleção. |
| get |
Obtém um slide usando sua ID exclusiva. |
| get |
Obtém um slide usando seu índice baseado em zero na coleção. Os slides são armazenados na mesma ordem que são mostrados na apresentação. |
| get |
Obtém um slide usando sua ID exclusiva. Se esse slide 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.Slide[];Valor da propriedade
Detalhes do método
getCount()
Obtém o número de slides na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
O número de slides na coleção.
Comentários
getItem(key)
Obtém um slide usando sua ID exclusiva.
getItem(key: string): PowerPoint.Slide;Parâmetros
- key
-
string
A ID do slide.
Retornos
O slide com a ID exclusiva. Se esse slide não existir, um erro será gerado.
Comentários
getItemAt(index)
Obtém um slide usando seu índice baseado em zero na coleção. Os slides são armazenados na mesma ordem que são mostrados na apresentação.
getItemAt(index: number): PowerPoint.Slide;Parâmetros
- index
-
number
O índice do slide na coleção.
Retornos
O slide no índice determinado. Um erro será gerado se o índice estiver fora do intervalo.
Comentários
[ Conjunto de API: PowerPointApi 1.2 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-slides.yaml
// Selects slides 2, 4, and 5.
await PowerPoint.run(async (context) => {
context.presentation.load("slides");
await context.sync();
const slide2 = context.presentation.slides.getItemAt(1);
const slide4 = context.presentation.slides.getItemAt(3);
const slide5 = context.presentation.slides.getItemAt(4);
slide2.load("id");
slide4.load("id");
slide5.load("id");
try {
await context.sync();
} catch (error) {
console.warn("This action requires at least 5 slides in the presentation.");
return;
}
await context.sync();
context.presentation.setSelectedSlides([slide2.id, slide4.id, slide5.id]);
await context.sync();
});
getItemOrNullObject(id)
Obtém um slide usando sua ID exclusiva. Se esse slide 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.Slide;Parâmetros
- id
-
string
A ID do slide.
Retornos
O slide 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.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideCollection;Parâmetros
- options
-
PowerPoint.Interfaces.SlideCollectionLoadOptions & 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.SlideCollection;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.SlideCollection;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.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original PowerPoint.SlideCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.SlideCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): PowerPoint.Interfaces.SlideCollectionData;Retornos
Comentários
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, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de