PowerPoint.SlideLayoutCollection class
Representa a coleção de esquemas fornecida pelo Modelo Global de Diapositivos para diapositivos.
- Extends
Comentários
[ Conjunto de API: PowerPointApi 1.3 ]
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 = 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 = 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 do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| get |
Obtém o número de esquemas na coleção. |
| get |
Obtém um esquema com o respetivo ID exclusivo. |
| get |
Obtém um esquema com o respetivo índice baseado em zero na coleção. |
| get |
Obtém um esquema com o respetivo ID exclusivo. Se tal esquema não existir, é devolvido 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 do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã 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 esquemas na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
O número de esquemas na coleção.
Comentários
getItem(key)
Obtém um esquema com o respetivo ID exclusivo.
getItem(key: string): PowerPoint.SlideLayout;Parâmetros
- key
-
string
O ID do esquema.
Retornos
O esquema com o ID exclusivo. Se tal esquema não existir, é gerado um erro.
Comentários
getItemAt(index)
Obtém um esquema com o respetivo índice baseado em zero na coleção.
getItemAt(index: number): PowerPoint.SlideLayout;Parâmetros
- index
-
number
O índice do esquema na coleção.
Retornos
O esquema no índice especificado. É apresentado um erro se o índice estiver fora do intervalo.
Comentários
getItemOrNullObject(id)
Obtém um esquema com o respetivo ID exclusivo. Se tal esquema não existir, é devolvido um objeto com uma isNullObject propriedade definida como verdadeiro. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getItemOrNullObject(id: string): PowerPoint.SlideLayout;Parâmetros
- id
-
string
O ID do esquema.
Retornos
O esquema com o ID exclusivo.
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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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 = 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 = 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.SlideLayoutCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.SlideLayoutCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito 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;