PowerPoint.SlideLayout class

Pacote:

powerpoint

Representa o esquema de um diapositivo.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

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.
id	Obtém o ID exclusivo do esquema de diapositivo.
name	Obtém o nome do esquema de diapositivo.
shapes	Devolve uma coleção de formas no esquema de diapositivo.

Métodos

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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Original PowerPoint.SlideLayout é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.SlideLayoutData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

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

PowerPoint.RequestContext

id

Obtém o ID exclusivo do esquema de diapositivo.

readonly id: string;

Valor da propriedade

string

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);
    }
  }
});

name

Obtém o nome do esquema de diapositivo.

readonly name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

shapes

Devolve uma coleção de formas no esquema de diapositivo.

readonly shapes: PowerPoint.ShapeCollection;

Valor da propriedade

PowerPoint.ShapeCollection

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

Detalhes do método

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.SlideLayoutLoadOptions): PowerPoint.SlideLayout;

Parâmetros

options

PowerPoint.Interfaces.SlideLayoutLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

PowerPoint.SlideLayout

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.SlideLayout;

Parâmetros

propertyNames

string | string[]

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

Retornos

PowerPoint.SlideLayout

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?: {
            select?: string;
            expand?: string;
        }): PowerPoint.SlideLayout;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

PowerPoint.SlideLayout

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.SlideLayout é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.SlideLayoutData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): PowerPoint.Interfaces.SlideLayoutData;

Retornos

PowerPoint.Interfaces.SlideLayoutData