PowerPoint.SlideMasterCollection class
Representa a coleção de Slides Mestres na apresentação.
- Extends
Comentários
Conjunto de APIs: PowerPointApi 1.3
Usada por
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
await PowerPoint.run(async function(context) {
// Load information about all the slide masters and associated layouts.
const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
await context.sync();
// Log the name and ID of each slide master.
for (let i = 0; i < slideMasters.items.length; i++) {
console.log("Master name: " + slideMasters.items[i].name);
console.log("Master ID: " + slideMasters.items[i].id);
// Log the name and ID of each slide layout in the slide master.
const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
for (let j = 0; j < layoutsInMaster.items.length; j++) {
console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
}
}
});
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 Mestres na coleção. |
| get |
Obtém um Slide Mestre usando sua ID exclusiva. |
| get |
Obtém um Slide Mestre usando seu índice baseado em zero na coleção. |
| get |
Obtém um Slide Mestre usando sua ID exclusiva. Se tal Slide Mestre 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.SlideMaster[];
Valor da propriedade
Detalhes do método
getCount()
Obtém o número de Slides Mestres na coleção.
getCount(): OfficeExtension.ClientResult<number>;
Retornos
OfficeExtension.ClientResult<number>
O número de Slides Mestres na coleção.
Comentários
getItem(key)
Obtém um Slide Mestre usando sua ID exclusiva.
getItem(key: string): PowerPoint.SlideMaster;
Parâmetros
- key
-
string
A ID do slide mestre.
Retornos
O Slide Mestre com a ID exclusiva. Se tal Slide Mestre não existir, um erro será gerado.
Comentários
getItemAt(index)
Obtém um Slide Mestre usando seu índice baseado em zero na coleção.
getItemAt(index: number): PowerPoint.SlideMaster;
Parâmetros
- index
-
number
O índice do Slide Mestre na coleção.
Retornos
O Slide Mestre no índice fornecido. Um erro será gerado se o índice estiver fora do intervalo.
Comentários
getItemOrNullObject(id)
Obtém um Slide Mestre usando sua ID exclusiva. Se tal Slide Mestre 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.SlideMaster;
Parâmetros
- id
-
string
A ID do slide mestre.
Retornos
O Slide Mestre 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.SlideMasterCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideMasterCollection;
Parâmetros
- options
-
PowerPoint.Interfaces.SlideMasterCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Fornece opções para quais propriedades do objeto devem ser carregadas.
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.SlideMasterCollection;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
await PowerPoint.run(async function(context) {
// Load information about all the slide masters and associated layouts.
const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
await context.sync();
// Log the name and ID of each slide master.
for (let i = 0; i < slideMasters.items.length; i++) {
console.log("Master name: " + slideMasters.items[i].name);
console.log("Master ID: " + slideMasters.items[i].id);
// Log the name and ID of each slide layout in the slide master.
const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
for (let j = 0; j < layoutsInMaster.items.length; j++) {
console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
}
}
});
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.SlideMasterCollection;
Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula 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.) Enquanto o objeto original PowerPoint.SlideMasterCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.SlideMasterCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.
toJSON(): PowerPoint.Interfaces.SlideMasterCollectionData;