Share via


PowerPoint.Slide class

Representa um único slide de uma 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.

id

Obtém a ID exclusiva do slide.

layout

Obtém o layout do slide.

shapes

Retorna uma coleção de formas no slide.

slideMaster

Obtém o SlideMaster objeto que representa o conteúdo padrão do slide.

tags

Retorna uma coleção de marcas no slide.

Métodos

delete()

Exclui o slide da apresentação. Não fará nada se o slide não existir.

exportAsBase64()

Exporta o slide para seu próprio arquivo de apresentação, retornado como dados codificados com base64.

getImageAsBase64(options)

Renderiza uma imagem do slide. A imagem é dimensionada para se encaixar nas dimensões desejadas. Se a largura e a altura não forem especificadas, o tamanho verdadeiro do slide será usado. Se apenas uma de largura ou altura for especificada, a outra será calculada para preservar a proporção.

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.

setSelectedShapes(shapeIds)

Seleciona as formas especificadas. A seleção de forma existente é substituída pela nova seleção.

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.) Enquanto o objeto original do PowerPoint.Slide é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.SlideData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

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

id

Obtém a ID exclusiva do slide.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: PowerPointApi 1.2 ]

layout

Obtém o layout do slide.

readonly layout: PowerPoint.SlideLayout;

Valor da propriedade

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

shapes

Retorna uma coleção de formas no slide.

readonly shapes: PowerPoint.ShapeCollection;

Valor da propriedade

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

slideMaster

Obtém o SlideMaster objeto que representa o conteúdo padrão do slide.

readonly slideMaster: PowerPoint.SlideMaster;

Valor da propriedade

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

tags

Retorna uma coleção de marcas no slide.

readonly tags: PowerPoint.TagCollection;

Valor da propriedade

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

Detalhes do método

delete()

Exclui o slide da apresentação. Não fará nada se o slide não existir.

delete(): void;

Retornos

void

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

// Deletes the selected slides.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slides = context.presentation.getSelectedSlides();
  const slideCount = slides.getCount();
  slides.load("items");
  await context.sync();
  slides.items.map((slide) => {
    slide.delete();
  });
});

exportAsBase64()

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 o slide para seu próprio arquivo de apresentação, retornado como dados codificados com base64.

exportAsBase64(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

[ Conjunto de API: PowerPointApi BETA (SOMENTE VERSÃO PRÉVIA) ]

getImageAsBase64(options)

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.

Renderiza uma imagem do slide. A imagem é dimensionada para se encaixar nas dimensões desejadas. Se a largura e a altura não forem especificadas, o tamanho verdadeiro do slide será usado. Se apenas uma de largura ou altura for especificada, a outra será calculada para preservar a proporção.

getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult<string>;

Parâmetros

options
PowerPoint.SlideGetImageOptions

Opcional. Opções para especificar o tamanho desejado da imagem de slide.

Retornos

Uma cadeia de caracteres base64 da imagem de slide no formato PNG.

Comentários

[ Conjunto de API: PowerPointApi BETA (SOMENTE VERSÃO PRÉVIA) ]

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.SlideLoadOptions): PowerPoint.Slide;

Parâmetros

options
PowerPoint.Interfaces.SlideLoadOptions

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

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

Parâmetros

propertyNamesAndPaths

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

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

setSelectedShapes(shapeIds)

Seleciona as formas especificadas. A seleção de forma existente é substituída pela nova seleção.

setSelectedShapes(shapeIds: string[]): void;

Parâmetros

shapeIds

string[]

Lista de IDs de forma a serem selecionadas no slide. Se a lista estiver vazia, a seleção será desmarcada.

Retornos

void

Comentários

[ Conjunto de API: PowerPointApi 1.5 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml

// Reselects shapes that were saved previously.
await PowerPoint.run(async (context) => {
  const slide1 = context.presentation.slides.getItem(savedSlideSelection[0]);
  await context.sync();
  slide1.setSelectedShapes(savedShapeSelection);
  await context.sync();
});

...

// Selects the first two shapes on slide 1.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide1 = context.presentation.slides.getItemAt(0);
  slide1.load("shapes");
  await context.sync();
  const shapes = slide1.shapes;
  const shape1 = shapes.getItemAt(0);
  const shape2 = shapes.getItemAt(1);
  shape1.load("id");
  shape2.load("id");
  await context.sync();
  slide1.setSelectedShapes([shape1.id, shape2.id]);
  await context.sync();
});

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.) Enquanto o objeto original do PowerPoint.Slide é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.SlideData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): PowerPoint.Interfaces.SlideData;

Retornos