PowerPoint.Slide class

Obtém o plano de fundo do slide.

readonly background: PowerPoint.SlideBackground;

Valor da propriedade

Comentários

Conjunto de APIs: PowerPointApi 1.10

Exemplos

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

// Gets the background fill type of the first selected slide.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  const fill: PowerPoint.SlideBackgroundFill = slide.background.fill;
  fill.load("type");
  await context.sync();

  const fillType = fill.type as PowerPoint.SlideBackgroundFillType;
  console.log(`Background fill type: ${fillType}`);
});

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

Retorna uma coleção de partes XML personalizadas no slide.

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Valor da propriedade

Comentários

Conjunto de APIs: PowerPointApi 1.7

Retorna uma coleção de hiperlinks no slide.

readonly hyperlinks: PowerPoint.HyperlinkCollection;

Valor da propriedade

Comentários

Conjunto de APIs: PowerPointApi 1.6

Exemplos

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

// Sets a hyperlink on the first selected shape.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  const shape: PowerPoint.Shape = context.presentation.getSelectedShapes().getItemAt(0).load("id,type");
  const hyperlinks: PowerPoint.HyperlinkCollection = slide.hyperlinks;
  const hyperlinkAddOptions: PowerPoint.HyperlinkAddOptions = {
    address: "https://bing.com",
    screenTip: "Screen tip for shape",
  };
  let hyperlink: PowerPoint.Hyperlink = hyperlinks.add(shape, hyperlinkAddOptions).load("address,screenTip");
  try {
    await context.sync();
  } catch {
    console.warn("Confirm that you have at least one slide and you've selected a shape on the active slide.");
    return;
  }

  console.log(
    `Added link "${hyperlink.address}" (screen tip: "${hyperlink.screenTip}") to the first selected shape (ID: ${shape.id}, type: ${shape.type}).`,
  );
});

Obtém a ID exclusiva do slide.

readonly id: string;

Valor da propriedade

Comentários

Conjunto de APIs: PowerPointApi 1.2

Retorna o índice baseado em zero do slide que representa sua posição na apresentação.

readonly index: number;

Valor da propriedade

Comentários

Conjunto de APIs: PowerPointApi 1.8

Obtém o layout do slide.

readonly layout: PowerPoint.SlideLayout;

Valor da propriedade

Comentários

Conjunto de APIs: PowerPointApi 1.3

Retorna uma coleção de formas no slide.

readonly shapes: PowerPoint.ShapeCollection;

Valor da propriedade

Comentários

Conjunto de APIs: PowerPointApi 1.3

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 APIs: PowerPointApi 1.3

Retorna uma coleção de marcas no slide.

readonly tags: PowerPoint.TagCollection;

Valor da propriedade

Comentários

Conjunto de APIs: PowerPointApi 1.3

Retorna o ThemeColorScheme do slide.

readonly themeColorScheme: PowerPoint.ThemeColorScheme;

Valor da propriedade

Comentários

Conjunto de APIs: PowerPointApi 1.10

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-theme-color-scheme.yaml

// Gets the theme color scheme for the first slide and logs all theme color values.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.slides.getItemAt(0);
  const colorScheme: PowerPoint.ThemeColorScheme = slide.themeColorScheme;

  // Queue up getThemeColor calls for each theme color.
  const colorResults = themeColorNames.map((colorName) => colorScheme.getThemeColor(colorName));
  await context.sync();

  // Display the results.
  console.log("Theme colors for slide 1:");
  themeColorNames.forEach((colorName, index) => {
    console.log(`  ${colorName}: ${colorResults[index].value}`);
  });
});

Aplica o layout especificado ao slide, alterando seu design e estrutura de acordo com o layout escolhido.

applyLayout(slideLayout: PowerPoint.SlideLayout): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: PowerPointApi 1.8

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

delete(): void;

Retornos

Comentários

Conjunto de APIs: 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();
  });
});

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

Observação: Este método é otimizado para exportar um único slide. Exportar vários slides pode afetar o desempenho.

exportAsBase64(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

Conjunto de APIs: 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.");
});

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

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

Parâmetros

Retornos

Uma cadeia de caracteres codificada em Base64 da imagem do slide no formato PNG.

Comentários

Conjunto de APIs: 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.");
});

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

Retornos

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

Retornos

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

Retornos

Move o slide para uma nova posição dentro da apresentação.

moveTo(slideIndex: number): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: PowerPointApi 1.8

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

setSelectedShapes(shapeIds: string[]): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: 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();
});

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original PowerPoint.Slide é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.SlideData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): PowerPoint.Interfaces.SlideData;

Retornos