Share via

PowerPoint.Presentation class

  • Referência
Pacote:
powerpoint
Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: PowerPointApi 1.0 ]

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 da apresentação.
slideMasters

Retorna a coleção de SlideMaster objetos que estão na apresentação.
slides

Retorna uma coleção ordenada de slides na apresentação.
tags

Retorna uma coleção de marcas anexadas à apresentação.
title

Métodos

getSelectedShapes()

Retorna as formas selecionadas no slide atual da apresentação. Se nenhuma forma for selecionada, uma coleção vazia será retornada.
getSelectedSlides()

Retorna os slides selecionados na exibição atual da apresentação. O primeiro item da coleção é o slide ativo que está visível na área de edição. Se nenhum slide for selecionado, uma coleção vazia será retornada.
getSelectedTextRange()

Retorna o PowerPoint.TextRange selecionado na exibição atual da apresentação. Gera uma exceção se nenhum texto for selecionado.
getSelectedTextRangeOrNullObject()

Retorna o PowerPoint.TextRange selecionado na exibição atual da apresentação. Se nenhum texto for selecionado, um objeto com uma isNullObject propriedade definida como true será retornado.
insertSlidesFromBase64(base64File, options)

Insere os slides especificados de uma apresentação na apresentação atual.
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.
setSelectedSlides(slideIds)

Seleciona os slides na exibição atual da apresentação. A seleção de slides 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.Presentation é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.PresentationData) 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

PowerPoint.RequestContext

id

Obtém a ID da apresentação.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: PowerPointApi 1.5 ]

slideMasters

Retorna a coleção de SlideMaster objetos que estão na apresentação.

readonly slideMasters: PowerPoint.SlideMasterCollection;

Valor da propriedade

PowerPoint.SlideMasterCollection

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

slides

Retorna uma coleção ordenada de slides na apresentação.

readonly slides: PowerPoint.SlideCollection;

Valor da propriedade

PowerPoint.SlideCollection

Comentários

[ Conjunto de API: PowerPointApi 1.2 ]

tags

Retorna uma coleção de marcas anexadas à apresentação.

readonly tags: PowerPoint.TagCollection;

Valor da propriedade

PowerPoint.TagCollection

Comentários

[ Conjunto de API: PowerPointApi 1.3 ]

title 

readonly title: string;

Valor da propriedade

string

Detalhes do método

getSelectedShapes()

Retorna as formas selecionadas no slide atual da apresentação. Se nenhuma forma for selecionada, uma coleção vazia será retornada.

getSelectedShapes(): PowerPoint.ShapeScopedCollection;

Retornos

PowerPoint.ShapeScopedCollection

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

...

// Gets the shapes you selected on the slide and displays their IDs on the task pane.
await PowerPoint.run(async (context) => {
  let finalTable = "";
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  await context.sync();
  finalTable += "<br>getSelectedShapes.getCount returned:<b>" + shapeCount.value + "</b><br>";
  finalTable +=
    "<br><table border=1 cellpadding=3 cellspacing=0><tr><td bgcolor=#3333EE><font color=white>Index</font></td><td bgcolor=#3333EE><font color=white>Id</font></td></tr>";
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape, index) => {
    finalTable += "<tr><td>" + index + "</td><td>" + shape.id + "</td></tr>";
  });
  finalTable += "</table>";
  $("#outputSpan").empty();
  $("#outputSpan").append(finalTable);
});

...

// Saves which shapes are selected so that they can be reselected later.
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();
  savedSlideSelection = [];
  slides.items.map((slide) => {
    savedSlideSelection.push(slide.id);
  });
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape) => {
    savedShapeSelection.push(shape.id);
  });
});

getSelectedSlides()

Retorna os slides selecionados na exibição atual da apresentação. O primeiro item da coleção é o slide ativo que está visível na área de edição. Se nenhum slide for selecionado, uma coleção vazia será retornada.

getSelectedSlides(): PowerPoint.SlideScopedCollection;

Retornos

PowerPoint.SlideScopedCollection

Comentários

[ Conjunto de API: PowerPointApi 1.5 ]

Exemplos

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

// Gets the selected slides and displays their IDs on the task pane.
await PowerPoint.run(async (context) => {
  let finalTable = "";
  context.presentation.load("slides");
  await context.sync();
  const allSlidesList = {};
  const allSlidesCount = context.presentation.slides.getCount();
  context.presentation.slides.load("items");
  await context.sync();
  let allSlideItems = context.presentation.slides.items;
  allSlideItems.map((slide, index) => {
    allSlidesList[slide.id] = `Slide ${index + 1}`;
  });

  if ($("#id-check-usenative").is(":checked")) {
    context.presentation.load("tags");
  }
  const slides = context.presentation.getSelectedSlides();
  const slideCount = slides.getCount();
  slides.load("items");
  await context.sync();
  finalTable += "<br>getSelectedSlides.getCount returned:<b>" + slideCount.value + "</b><br>";
  finalTable +=
    "<br><table border=1 cellpadding=3 cellspacing=0><tr><td bgcolor=#3333EE><font color=white>Index</font></td><td bgcolor=#3333EE><font color=white>Id</font></td></tr>";
  slides.items.map((slide, index) => {
    finalTable += "<tr><td>" + index + " - " + allSlidesList[slide.id] + "</td><td>" + slide.id + "</td></tr>";
  });
  finalTable += "</table>";
  $("#outputSpan").empty();
  $("#outputSpan").append(finalTable);
});

...

// Saves which slides are currently selected so they can be reselected later.
await PowerPoint.run(async (context) => {
  let finalTable = "";
  context.presentation.load("slides");
  await context.sync();
  const slides = context.presentation.getSelectedSlides();
  const slideCount = slides.getCount();
  await context.sync();
  finalTable += "<br>getSelectedSlides.getCount returned:<b>" + slideCount.value + "</b><br>";
  finalTable +=
    "<br><table border=1 cellpadding=3 cellspacing=0><tr><td bgcolor=#3333EE><font color=white>Index</font></td><td bgcolor=#3333EE><font color=white>Id</font></td></tr>";
  savedSlideSelection = [];
  slides.load("items");
  await context.sync();
  slides.items.map((slide, index) => {
    finalTable += "<tr><td>" + index + "</td><td>" + slide.id + "</td></tr>";
    savedSlideSelection.push(slide.id);
  });
  finalTable += "</table>";
  $("#outputSpan").empty();
  $("#outputSpan").append(finalTable);
});

getSelectedTextRange()

Retorna o PowerPoint.TextRange selecionado na exibição atual da apresentação. Gera uma exceção se nenhum texto for selecionado.

getSelectedTextRange(): PowerPoint.TextRange;

Retornos

PowerPoint.TextRange

Comentários

[ Conjunto de API: PowerPointApi 1.5 ]

Exemplos

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

// Gets the selected text range and prints data about the range on the task pane.
await PowerPoint.run(async (context) => {
  const textRange = context.presentation.getSelectedTextRange();
  try {
    await context.sync();
  } catch (error) {
    console.warn("You must select only one range of text for this action to work.");
    return;
  }
  textRange.load("text");
  textRange.load("start");
  textRange.load("length");
  await context.sync();
  let txtHtml = textRange.text;
  txtHtml = txtHtml.replace(/\n/g, "<br>");
  txtHtml = txtHtml.replace(/\r/g, "<br>");
  txtHtml = txtHtml.replace(/\v/g, "<br>");
  let txtExplained = textRange.text;
  txtExplained = txtExplained.replace(/\n/g, "<font color=red>NL</font>");
  txtExplained = txtExplained.replace(/\r/g, "<font color=red>CR</font>");
  txtExplained = txtExplained.replace(/\v/g, "<font color=red>VV</font>");
  let finalTable = "";
  finalTable +=
    "<br><table border=1 cellpadding=3 cellspacing=0><tr><td bgcolor=#3333EE><font color=white>Index</font></td><td bgcolor=#3333EE><font color=white>Id</font></td></tr>";
  finalTable += "<tr><td>Raw</td><td>" + textRange.text + "</td></tr>";
  finalTable += "<tr><td>Html</td><td>" + txtHtml + "</td></tr>";
  finalTable += "<tr><td>Exp</td><td>" + txtExplained + "</td></tr>";
  finalTable += "<tr><td>Start</td><td>" + textRange.start + "</td></tr>";
  finalTable += "<tr><td>Length</td><td>" + textRange.length + "</td></tr>";
  finalTable += "</table>";
  $("#outputSpan").empty();
  $("#outputSpan").append(finalTable);
});

...

// Sets the range selection to the range that was saved previously.
await PowerPoint.run(async (context) => {
  const slide1 = context.presentation.slides.getItem(savedTextSlideSelection[0]);
  const shape1 = slide1.shapes.getItem(savedTextShapeSelection[0]);
  const textRange = shape1.textFrame.textRange.getSubstring(savedTextTextRangeStart, savedTextTextRangeLength);
  textRange.setSelected();
  await context.sync();
});

getSelectedTextRangeOrNullObject()

Retorna o PowerPoint.TextRange selecionado na exibição atual da apresentação. Se nenhum texto for selecionado, um objeto com uma isNullObject propriedade definida como true será retornado.

getSelectedTextRangeOrNullObject(): PowerPoint.TextRange;

Retornos

PowerPoint.TextRange

Comentários

[ Conjunto de API: PowerPointApi 1.5 ]

insertSlidesFromBase64(base64File, options)

Insere os slides especificados de uma apresentação na apresentação atual.

insertSlidesFromBase64(base64File: string, options?: PowerPoint.InsertSlideOptions): void;

Parâmetros

base64File

string

A cadeia de caracteres codificada base64 que representa o arquivo de apresentação de origem.

options
PowerPoint.InsertSlideOptions

As opções que definem quais slides serão inseridos, para onde serão os novos slides e qual formatação da apresentação será usada.

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/insert-slides.yaml

await PowerPoint.run(async function(context) {
    const selectedSlideID = await getSelectedSlideID();

    context.presentation.insertSlidesFromBase64(chosenFileBase64, {
        formatting: PowerPoint.InsertSlideFormatting.useDestinationTheme,
        targetSlideId: selectedSlideID + "#"
    });
    await context.sync();
});

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.PresentationLoadOptions): PowerPoint.Presentation;

Parâmetros

options
PowerPoint.Interfaces.PresentationLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

PowerPoint.Presentation

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

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

PowerPoint.Presentation

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

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

PowerPoint.Presentation

setSelectedSlides(slideIds)

Seleciona os slides na exibição atual da apresentação. A seleção de slides existente é substituída pela nova seleção.

setSelectedSlides(slideIds: string[]): void;

Parâmetros

slideIds

string[]

Lista de IDs de slides a serem selecionadas na apresentação. 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/slide-management/get-set-slides.yaml

// Sets selection to the slides that were saved.
await PowerPoint.run(async (context) => {
  context.presentation.setSelectedSlides(savedSlideSelection);
  await context.sync();
});

...

// Selects slides 2, 4, and 5.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide2 = context.presentation.slides.getItemAt(1);
  const slide4 = context.presentation.slides.getItemAt(3);
  const slide5 = 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();
});

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

toJSON(): PowerPoint.Interfaces.PresentationData;

Retornos

PowerPoint.Interfaces.PresentationData