Compartilhar via


PowerPoint.Slide class

Representa um único diapositivo de uma apresentação.

Extends

Comentários

[ Conjunto de API: PowerPointApi 1.2 ]

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: PowerPoint.Slide = context.presentation.slides.getItem(savedSlideSelection[0]);
  await context.sync();
  slide1.setSelectedShapes(savedShapeSelection);
  await context.sync();
});

Propriedades

background

Obtém o fundo do diapositivo.

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

customXmlParts

Devolve uma coleção de peças XML personalizadas no diapositivo.

hyperlinks

Devolve uma coleção de hiperligações no diapositivo.

id

Obtém o ID exclusivo do diapositivo.

index

Devolve o índice baseado em zero do diapositivo que representa a sua posição na apresentação.

layout

Obtém o esquema do diapositivo.

shapes

Devolve uma coleção de formas no diapositivo.

slideMaster

Obtém o SlideMaster objeto que representa o conteúdo predefinido do diapositivo.

tags

Devolve uma coleção de etiquetas no diapositivo.

themeColorScheme

Devolve o ThemeColorScheme do diapositivo.

Métodos

applyLayout(slideLayout)

Aplica o esquema especificado ao diapositivo, alterando a estrutura e a estrutura de acordo com o esquema escolhido.

delete()

Elimina o diapositivo da apresentação. Não faz nada se o diapositivo não existir.

exportAsBase64()

Exporta o diapositivo para o seu próprio ficheiro de apresentação, devolvido como dados codificados com Base64.

Nota: este método está otimizado para exportar um único diapositivo. A exportação de vários diapositivos pode afetar o desempenho.

getImageAsBase64(options)

Compõe uma imagem do diapositivo. A imagem é dimensionada para caber nas dimensões pretendidas. Se a largura e a altura não forem especificadas, é utilizado o tamanho verdadeiro do diapositivo. 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.

moveTo(slideIndex)

Move o diapositivo para uma nova posição na apresentação.

setSelectedShapes(shapeIds)

Seleciona as formas especificadas. A seleção de formas 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.Slide é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.SlideData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

background

Obtém o fundo do diapositivo.

readonly background: PowerPoint.SlideBackground;

Valor da propriedade

Comentários

[ Conjunto de API: PowerPointApi 1.10 ]

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

customXmlParts

Devolve uma coleção de peças XML personalizadas no diapositivo.

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Valor da propriedade

Comentários

[ Conjunto de API: PowerPointApi 1.7 ]

Devolve uma coleção de hiperligações no diapositivo.

readonly hyperlinks: PowerPoint.HyperlinkCollection;

Valor da propriedade

Comentários

[ Conjunto de API: PowerPointApi 1.6 ]

id

Obtém o ID exclusivo do diapositivo.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: PowerPointApi 1.2 ]

index

Devolve o índice baseado em zero do diapositivo que representa a sua posição na apresentação.

readonly index: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

layout

Obtém o esquema do diapositivo.

readonly layout: PowerPoint.SlideLayout;

Valor da propriedade

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

shapes

Devolve uma coleção de formas no diapositivo.

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 predefinido do diapositivo.

readonly slideMaster: PowerPoint.SlideMaster;

Valor da propriedade

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

tags

Devolve uma coleção de etiquetas no diapositivo.

readonly tags: PowerPoint.TagCollection;

Valor da propriedade

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

themeColorScheme

Devolve o ThemeColorScheme do diapositivo.

readonly themeColorScheme: PowerPoint.ThemeColorScheme;

Valor da propriedade

Comentários

[ Conjunto de API: PowerPointApi 1.10 ]

Detalhes do método

applyLayout(slideLayout)

Aplica o esquema especificado ao diapositivo, alterando a estrutura e a estrutura de acordo com o esquema escolhido.

applyLayout(slideLayout: PowerPoint.SlideLayout): void;

Parâmetros

slideLayout
PowerPoint.SlideLayout

O esquema a aplicar ao diapositivo. Normalmente, esta é uma instância de um esquema predefinido do diapositivo master.

Retornos

void

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

delete()

Elimina o diapositivo da apresentação. Não faz nada se o diapositivo 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: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
  const slideCount = slides.getCount();
  slides.load("items");
  await context.sync();
  slides.items.map((slide) => {
    slide.delete();
  });
});

exportAsBase64()

Exporta o diapositivo para o seu próprio ficheiro de apresentação, devolvido como dados codificados com Base64.

Nota: este método está otimizado para exportar um único diapositivo. A exportação de vários diapositivos pode afetar o desempenho.

exportAsBase64(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

Exemplos

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

// Exports current slide.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.getSelectedSlides().getItemAt(0);
  const slideBase64DataResult = slide.exportAsBase64();
  const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
  await context.sync();

  localStorage.setItem("exportedSlide", slideBase64DataResult.value);
  localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);

  updateSlideImage(imageBase64DataResult.value);

  console.log("Slide was exported.");
});

getImageAsBase64(options)

Compõe uma imagem do diapositivo. A imagem é dimensionada para caber nas dimensões pretendidas. Se a largura e a altura não forem especificadas, é utilizado o tamanho verdadeiro do diapositivo. 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 pretendido da imagem do diapositivo.

Retornos

Uma cadeia codificada com Base64 da imagem do diapositivo no formato PNG.

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

Exemplos

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

// Exports current slide.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.getSelectedSlides().getItemAt(0);
  const slideBase64DataResult = slide.exportAsBase64();
  const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
  await context.sync();

  localStorage.setItem("exportedSlide", slideBase64DataResult.value);
  localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);

  updateSlideImage(imageBase64DataResult.value);

  console.log("Slide was exported.");
});

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

Parâmetros

propertyNames

string | string[]

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

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

moveTo(slideIndex)

Move o diapositivo para uma nova posição na apresentação.

moveTo(slideIndex: number): void;

Parâmetros

slideIndex

number

O índice baseado em zero para onde o diapositivo deve ser movido.

Retornos

void

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

setSelectedShapes(shapeIds)

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

setSelectedShapes(shapeIds: string[]): void;

Parâmetros

shapeIds

string[]

Lista de IDs de formas a selecionar no diapositivo. 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: PowerPoint.Slide = 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/items/type");
  await context.sync();

  const shapes = slide1.shapes.items.filter((item) => item.type === PowerPoint.ShapeType.geometricShape);
  const shape1: PowerPoint.Shape = shapes[0];
  const shape2: PowerPoint.Shape = shapes[1];
  shape1.load("id");
  shape2.load("id");
  await context.sync();

  console.log(`IDs: ${shape1.id}, ${shape2.id}`);
  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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.Slide é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.SlideData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): PowerPoint.Interfaces.SlideData;

Retornos