PowerPoint.SlideCollection class

Pacote:: powerpoint

Representa a coleção de diapositivos na apresentação.

Extends: OfficeExtension.ClientObject

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml

const chosenMaster = (document.getElementById("master-id") as HTMLInputElement).value;
const chosenLayout = (document.getElementById("layout-id") as HTMLInputElement).value;

await PowerPoint.run(async function(context) {
  // Create a new slide using an existing master slide and layout.
  const newSlideOptions: PowerPoint.AddSlideOptions = {
    slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
    layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
  };
  context.presentation.slides.add(newSlideOptions);
  await context.sync();
});

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

add(options)	Adiciona um novo diapositivo à coleção.
exportAsBase64Presentation(values)	Exporta um ou mais diapositivos encontrados nesta coleção para o seu próprio ficheiro de apresentação, devolvidos como dados codificados com Base64. Gera uma exceção `InvalidArgument` se os IDs ou `Slide` objetos de diapositivos fornecidos não forem encontrados nesta coleção.
getCount()	Obtém o número de diapositivos na coleção.
getItem(key)	Obtém um diapositivo com o ID exclusivo.
getItemAt(index)	Obtém um diapositivo com o respetivo índice baseado em zero na coleção. Os diapositivos são armazenados pela mesma ordem que são apresentados na apresentação.
getItemOrNullObject(id)	Obtém um diapositivo com o ID exclusivo. Se tal diapositivo 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).
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.stringify`por sua vez, chama o `toJSON` método do objeto que lhe é transmitido.) Enquanto o objeto original `PowerPoint.SlideCollection` é um objeto de API, o `toJSON` método devolve um objeto JavaScript simples (escrito como `PowerPoint.Interfaces.SlideCollectionData`) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

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

items

Obtém os itens filhos carregados nesta coleção.

readonly items: PowerPoint.Slide[];

Valor da propriedade

PowerPoint.Slide[]

Detalhes do método

add(options)

Adiciona um novo diapositivo à coleção.

add(options?: PowerPoint.AddSlideOptions): void;

Parâmetros

options: PowerPoint.AddSlideOptions

Opcional. Opções para configurar as propriedades do novo diapositivo.

Retornos

void

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

const chosenMaster = (document.getElementById("master-id") as HTMLInputElement).value;
const chosenLayout = (document.getElementById("layout-id") as HTMLInputElement).value;

await PowerPoint.run(async function(context) {
  // Create a new slide using an existing master slide and layout.
  const newSlideOptions: PowerPoint.AddSlideOptions = {
    slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
    layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
  };
  context.presentation.slides.add(newSlideOptions);
  await context.sync();
});

exportAsBase64Presentation(values)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Exporta um ou mais diapositivos encontrados nesta coleção para o seu próprio ficheiro de apresentação, devolvidos como dados codificados com Base64. Gera uma exceção InvalidArgument se os IDs ou Slide objetos de diapositivos fornecidos não forem encontrados nesta coleção.

exportAsBase64Presentation(values: Array<string | Slide>): OfficeExtension.ClientResult<string>;

Parâmetros

values: Array<string | PowerPoint.Slide>

Uma matriz de IDs ou Slide objetos de diapositivos.

Retornos

OfficeExtension.ClientResult<string>

Uma cadeia codificada em Base64.

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

getCount()

Obtém o número de diapositivos na coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

O número de diapositivos na coleção.

Comentários

[ Conjunto de API: PowerPointApi 1.2 ]

getItem(key)

Obtém um diapositivo com o ID exclusivo.

getItem(key: string): PowerPoint.Slide;

Parâmetros

key: string

O ID do diapositivo.

Retornos

PowerPoint.Slide

O diapositivo com o ID exclusivo. Se tal diapositivo não existir, é gerado um erro.

Comentários

[ Conjunto de API: PowerPointApi 1.2 ]

getItemAt(index)

Obtém um diapositivo com o respetivo índice baseado em zero na coleção. Os diapositivos são armazenados pela mesma ordem que são apresentados na apresentação.

getItemAt(index: number): PowerPoint.Slide;

Parâmetros

index: number

O índice do diapositivo na coleção.

Retornos

PowerPoint.Slide

O diapositivo no índice especificado. É apresentado um erro 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: PowerPoint.Slide = context.presentation.slides.getItemAt(1);
  const slide4: PowerPoint.Slide = context.presentation.slides.getItemAt(3);
  const slide5: PowerPoint.Slide = 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 diapositivo com o ID exclusivo. Se tal diapositivo 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.Slide;

Parâmetros

id: string

O ID do diapositivo.

Retornos

PowerPoint.Slide

O diapositivo com o ID exclusivo.

Comentários

[ Conjunto de API: PowerPointApi 1.2 ]

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 as propriedades do objeto a carregar.

Retornos

PowerPoint.SlideCollection

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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

PowerPoint.SlideCollection

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 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.SlideCollection

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.SlideCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito 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

PowerPoint.Interfaces.SlideCollectionData

Comentários

Esta página foi útil?

Compartilhar via

PowerPoint.SlideCollection class

Comentários

Exemplos

Propriedades

Métodos

Detalhes da propriedade

context

Valor da propriedade

items

Valor da propriedade

Detalhes do método

add(options)

Parâmetros

Retornos

Comentários

Exemplos

exportAsBase64Presentation(values)

Parâmetros

Retornos

Comentários

getCount()

Retornos

Comentários

getItem(key)

Parâmetros

Retornos

Comentários

getItemAt(index)

Parâmetros

Retornos

Comentários

Exemplos

getItemOrNullObject(id)

Parâmetros

Retornos

Comentários

load(options)

Parâmetros

Retornos

load(propertyNames)

Parâmetros

Retornos

load(propertyNamesAndPaths)

Parâmetros

Retornos

toJSON()

Retornos

Comentários