PowerPoint.Presentation class

Пакет:: powerpoint

Объект Presentation — это объект верхнего уровня с одним или несколькими слайдами, содержащими содержимое презентации. Дополнительные сведения об объектной модели PowerPoint см. в статье Объектная модель JavaScript для PowerPoint.

Расширяет: OfficeExtension.ClientObject

Замечания

[ Набор API: PowerPointApi 1.0 ]

Примеры

// 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) {
    // Get the ID of the first selected slide.
    const presentation: PowerPoint.Presentation = context.presentation;
    const selected: PowerPoint.Slide = presentation.getSelectedSlides().getItemAt(0);
    selected.load("id");
    await context.sync();

    // Insert the other presentation after the selected slide.
    const insertOptions: PowerPoint.InsertSlideOptions = {
        formatting: PowerPoint.InsertSlideFormatting.useDestinationTheme,
        targetSlideId: selected.id
    };
    presentation.insertSlidesFromBase64(chosenFileBase64, insertOptions);
    await context.sync();
});

Свойства

bindings	Возвращает коллекцию привязок, связанных с презентацией.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
customXmlParts	Возвращает коллекцию настраиваемых XML-частей, связанных с презентацией.
id	Возвращает идентификатор презентации.
pageSetup	Возвращает сведения о настройке страницы, свойства которой управляют атрибутами настройки слайдов для презентации.
properties	Возвращает свойства презентации.
slideMasters	Возвращает коллекцию `SlideMaster` объектов, которые находятся в презентации.
slides	Возвращает упорядоченную коллекцию слайдов в презентации.
tags	Возвращает коллекцию тегов, присоединенных к презентации.
title	Возвращает заголовок презентации.

Методика

getActiveSlideOrNullObject()	Возвращает текущий активный элемент PowerPoint.Slide , видимый в области редактирования. Если активного слайда нет, возвращается объект со свойством `isNullObject` , для свойства который задано `true` значение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getSelectedShapes()	Возвращает выбранные фигуры на текущем слайде презентации. Если фигуры не выбраны, возвращается пустая коллекция.
getSelectedSlides()	Возвращает выбранные слайды в текущем представлении презентации. Первым элементом в коллекции является активный слайд, который отображается в области редактирования. Если слайды не выбраны, возвращается пустая коллекция.
getSelectedTextRange()	Возвращает выбранный объект PowerPoint.TextRange в текущем представлении презентации. Создает исключение, если текст не выделен.
getSelectedTextRangeOrNullObject()	Возвращает выбранный объект PowerPoint.TextRange в текущем представлении презентации. Если текст не выбран, возвращается объект со свойством `isNullObject` , для свойства , который имеет значение `true` . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
insertSlidesFromBase64(base64File, options)	Вставляет указанные слайды из презентации в текущую презентацию.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
setSelectedSlides(slideIds)	Выбирает слайды в текущем представлении презентации. Существующий фрагмент слайда заменяется новым выделением.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `PowerPoint.Presentation` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `PowerPoint.Interfaces.PresentationData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Подробнее

bindings

Возвращает коллекцию привязок, связанных с презентацией.

readonly bindings: PowerPoint.BindingCollection;

Стоимость недвижимости

PowerPoint.BindingCollection

Замечания

[ Набор API: PowerPointApi 1.8 ]

Примеры

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

// Loads bindings.
await PowerPoint.run(async (context) => {
  const bindings = context.presentation.bindings;
  bindings.load("items");
  await context.sync();

  const bindingCount = bindings.items.length;
  if (bindingCount === 0) {
    console.log(`There are no bindings.`);
  } else if (bindingCount === 1) {
    console.log("There's 1 binding.");
  } else {
    console.log(`There are ${bindingCount} bindings.`);
  }

  bindings.items.forEach((binding) => {
    getShapeForBindingId(binding.id).then((shape) => {
      if (shape) {
        console.log(`Binding ID: ${binding.id} refers to shape ID ${shape.id}`);
      } else {
        console.log(`Binding ID: ${binding.id} doesn't refers to shape.`);
      }
    });
  });

  populateBindingsDropdown(bindings.items);
});

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Стоимость недвижимости

PowerPoint.RequestContext

customXmlParts

Возвращает коллекцию настраиваемых XML-частей, связанных с презентацией.

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Стоимость недвижимости

PowerPoint.CustomXmlPartCollection

Замечания

[ Набор API: PowerPointApi 1.7 ]

id

Возвращает идентификатор презентации.

readonly id: string;

Стоимость недвижимости

string

Замечания

[ Набор API: PowerPointApi 1.5 ]

pageSetup

Возвращает сведения о настройке страницы, свойства которой управляют атрибутами настройки слайдов для презентации.

readonly pageSetup: PowerPoint.PageSetup;

Стоимость недвижимости

PowerPoint.PageSetup

Замечания

[ Набор API: PowerPointApi 1.10 ]

properties

Возвращает свойства презентации.

readonly properties: PowerPoint.DocumentProperties;

Стоимость недвижимости

PowerPoint.DocumentProperties

Замечания

[ Набор API: PowerPointApi 1.7 ]

slideMasters

Возвращает коллекцию SlideMaster объектов, которые находятся в презентации.

readonly slideMasters: PowerPoint.SlideMasterCollection;

Стоимость недвижимости

PowerPoint.SlideMasterCollection

Замечания

[ Набор API: PowerPointApi 1.3 ]

slides

Возвращает упорядоченную коллекцию слайдов в презентации.

readonly slides: PowerPoint.SlideCollection;

Стоимость недвижимости

PowerPoint.SlideCollection

Замечания

[ Набор API: PowerPointApi 1.2 ]

title

Возвращает заголовок презентации.

readonly title: string;

Стоимость недвижимости

string

Замечания

[ Набор API: PowerPointApi 1.0 ]

Подробнее о методе

getActiveSlideOrNullObject()

Заметка

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен в зависимости от полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает текущий активный элемент PowerPoint.Slide , видимый в области редактирования. Если активного слайда нет, возвращается объект со свойством isNullObject , для свойства который задано true значение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getActiveSlideOrNullObject(): PowerPoint.Slide;

Возвращает

PowerPoint.Slide

Замечания

[ Набор API: PowerPointApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/preview-apis/presentation-get-active-slide.yaml

await PowerPoint.run(async (context) => {
  // Gets the active slide in the presentation.
  const slide: PowerPoint.Slide = context.presentation.getActiveSlideOrNullObject();
  slide.load("id");
  const activeSlideImage = slide.getImageAsBase64({ height: 200 });
  await context.sync();

  if (slide.isNullObject) {
    console.log("There are no slides in this presentation.");
    return;
  }

  console.log(`Active slide ID: ${slide.id}`);

  updateSlideImage(activeSlideImage.value);
});

getSelectedShapes()

Возвращает выбранные фигуры на текущем слайде презентации. Если фигуры не выбраны, возвращается пустая коллекция.

getSelectedShapes(): PowerPoint.ShapeScopedCollection;

Возвращает

PowerPoint.ShapeScopedCollection

Замечания

[ Набор API: PowerPointApi 1.5 ]

Примеры

// 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: PowerPoint.ShapeScopedCollection = 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: PowerPoint.ShapeScopedCollection = 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>";
  const outputSpan = document.getElementById("outputSpan");
  outputSpan.innerHTML = "";
  outputSpan.innerHTML += 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: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
  const slideCount = slides.getCount();
  slides.load("items");
  await context.sync();
  savedSlideSelection = [];
  slides.items.map((slide) => {
    savedSlideSelection.push(slide.id);
  });
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape) => {
    savedShapeSelection.push(shape.id);
  });
});

getSelectedSlides()

Возвращает выбранные слайды в текущем представлении презентации. Первым элементом в коллекции является активный слайд, который отображается в области редактирования. Если слайды не выбраны, возвращается пустая коллекция.

getSelectedSlides(): PowerPoint.SlideScopedCollection;

Возвращает

PowerPoint.SlideScopedCollection

Замечания

[ Набор API: PowerPointApi 1.5 ]

Примеры

// 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: PowerPoint.Slide[] = context.presentation.slides.items;
  allSlideItems.map((slide, index) => {
    allSlidesList[slide.id] = `Slide ${index + 1}`;
  });

  const checkbox = document.getElementById("id-check-usenative") as HTMLInputElement;
  if (checkbox && checkbox.checked) {
    context.presentation.load("tags");
  }

  const slides: PowerPoint.SlideScopedCollection = 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>";
  const outputSpan = document.getElementById("outputSpan");
  outputSpan.innerHTML = ""
  outputSpan.innerHTML += 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: PowerPoint.SlideScopedCollection = 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>";
  const outputSpan = document.getElementById("outputSpan");
  outputSpan.innerHTML = ""
  outputSpan.innerHTML += finalTable;
});

getSelectedTextRange()

Возвращает выбранный объект PowerPoint.TextRange в текущем представлении презентации. Создает исключение, если текст не выделен.

getSelectedTextRange(): PowerPoint.TextRange;

Возвращает

PowerPoint.TextRange

Замечания

[ Набор API: PowerPointApi 1.5 ]

Примеры

// 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: PowerPoint.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 +=
    "<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>";
  const outputSpan = document.getElementById("outputSpan");
  outputSpan.innerHTML = "";
  outputSpan.innerHTML += finalTable;
});

...

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

getSelectedTextRangeOrNullObject()

Возвращает выбранный объект PowerPoint.TextRange в текущем представлении презентации. Если текст не выбран, возвращается объект со свойством isNullObject , для свойства , который имеет значение true . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getSelectedTextRangeOrNullObject(): PowerPoint.TextRange;

Возвращает

PowerPoint.TextRange

Замечания

[ Набор API: PowerPointApi 1.5 ]

insertSlidesFromBase64(base64File, options)

Вставляет указанные слайды из презентации в текущую презентацию.

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

Параметры

base64File: string

Строка в кодировке Base64, представляющая исходный файл презентации.

options: PowerPoint.InsertSlideOptions

Параметры, определяющие, какие слайды будут вставлены, куда будут идти новые слайды, а также какие будут использоваться форматирование презентации.

Возвращает

void

Замечания

[ Набор API: PowerPointApi 1.2 ]

Примеры

// 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) {
    // Get the ID of the first selected slide.
    const presentation: PowerPoint.Presentation = context.presentation;
    const selected: PowerPoint.Slide = presentation.getSelectedSlides().getItemAt(0);
    selected.load("id");
    await context.sync();

    // Insert the other presentation after the selected slide.
    const insertOptions: PowerPoint.InsertSlideOptions = {
        formatting: PowerPoint.InsertSlideFormatting.useDestinationTheme,
        targetSlideId: selected.id
    };
    presentation.insertSlidesFromBase64(chosenFileBase64, insertOptions);
    await context.sync();
});

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: PowerPoint.Interfaces.PresentationLoadOptions): PowerPoint.Presentation;

Параметры

options: PowerPoint.Interfaces.PresentationLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращает

PowerPoint.Presentation

load(propertyNames)

load(propertyNames?: string | string[]): PowerPoint.Presentation;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращает

PowerPoint.Presentation

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Presentation;

Параметры

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращает

PowerPoint.Presentation

setSelectedSlides(slideIds)

Выбирает слайды в текущем представлении презентации. Существующий фрагмент слайда заменяется новым выделением.

setSelectedSlides(slideIds: string[]): void;

Параметры

slideIds: string[]

Список идентификаторов слайдов для выбора в презентации. Если список пуст, выделение очищается.

Возвращает

void

Замечания

[ Набор API: PowerPointApi 1.5 ]

Примеры

// 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: 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();
});

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.Presentation объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.PresentationData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): PowerPoint.Interfaces.PresentationData;

Возвращает

PowerPoint.Interfaces.PresentationData

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

PowerPoint.Presentation class

Замечания

Примеры

Свойства

Методика

Подробнее

bindings

Стоимость недвижимости

Замечания

Примеры

context

Стоимость недвижимости

customXmlParts

Стоимость недвижимости

Замечания

id

Стоимость недвижимости

Замечания

pageSetup

Стоимость недвижимости

Замечания

properties

Стоимость недвижимости

Замечания

slideMasters

Стоимость недвижимости

Замечания

slides

Стоимость недвижимости

Замечания

tags

Стоимость недвижимости

Замечания

title

Стоимость недвижимости

Замечания

Подробнее о методе

getActiveSlideOrNullObject()

Возвращает

Замечания

Примеры

getSelectedShapes()

Возвращает

Замечания

Примеры

getSelectedSlides()

Возвращает

Замечания

Примеры

getSelectedTextRange()

Возвращает

Замечания

Примеры

getSelectedTextRangeOrNullObject()

Возвращает

Замечания

insertSlidesFromBase64(base64File, options)

Параметры

Возвращает

Замечания

Примеры

load(options)

Параметры

Возвращает

load(propertyNames)

Параметры

Возвращает

load(propertyNamesAndPaths)

Параметры

Возвращает

setSelectedSlides(slideIds)

Параметры

Возвращает

Замечания

Примеры

toJSON()

Возвращает

Обратная связь