powerpoint package

Классы

PowerPoint.Application
PowerPoint.Presentation
PowerPoint.RequestContext	Объект RequestContext упрощает запросы к приложению PowerPoint. Так как надстройка Office и приложение PowerPoint выполняются в двух разных процессах, контекст запроса необходим для получения доступа к объектной модели PowerPoint из надстройки.
PowerPoint.Shape	Представляет одну фигуру на слайде.
PowerPoint.ShapeCollection	Представляет коллекцию фигур.
PowerPoint.Slide	Представляет один слайд презентации.
PowerPoint.SlideCollection	Представляет коллекцию слайдов в презентации.
PowerPoint.SlideLayout	Представляет макет слайда.
PowerPoint.SlideLayoutCollection	Представляет коллекцию макетов, предоставляемых образцом слайдов для слайдов.
PowerPoint.SlideMaster	Представляет образец слайдов слайда.
PowerPoint.SlideMasterCollection	Представляет коллекцию образцов слайдов в презентации.
PowerPoint.Tag	Представляет один тег на слайде.
PowerPoint.TagCollection	Представляет коллекцию тегов.

Интерфейсы

PowerPoint.AddSlideOptions	Представляет доступные параметры при добавлении нового слайда.
PowerPoint.InsertSlideOptions	Представляет доступные параметры при вставке слайдов.
PowerPoint.Interfaces.BulletFormatData	Интерфейс, описывающий данные, возвращаемые путем вызова bulletFormat.toJSON().
PowerPoint.Interfaces.BulletFormatUpdateData	Интерфейс для обновления данных объекта BulletFormat для использования в bulletFormat.set({ ... }).
PowerPoint.Interfaces.CollectionLoadOptions	Предоставляет способы загрузки свойств только подмножества элементов коллекции.
PowerPoint.Interfaces.HyperlinkCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова hyperlinkCollection.toJSON().
PowerPoint.Interfaces.HyperlinkCollectionUpdateData	Интерфейс для обновления данных объекта HyperlinkCollection для использования в hyperlinkCollection.set({ ... }).
PowerPoint.Interfaces.HyperlinkData	Интерфейс, описывающий данные, возвращаемые путем вызова hyperlink.toJSON().
PowerPoint.Interfaces.HyperlinkUpdateData	Интерфейс для обновления данных объекта Hyperlink для использования в hyperlink.set({ ... }).
PowerPoint.Interfaces.ParagraphFormatData	Интерфейс, описывающий данные, возвращаемые путем вызова paragraphFormat.toJSON().
PowerPoint.Interfaces.ParagraphFormatUpdateData	Интерфейс для обновления данных объекта ParagraphFormat для использования в paragraphFormat.set({ ... }).
PowerPoint.Interfaces.PresentationData	Интерфейс, описывающий данные, возвращаемые путем вызова presentation.toJSON().
PowerPoint.Interfaces.PresentationLoadOptions
PowerPoint.Interfaces.ShapeCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова shapeCollection.toJSON().
PowerPoint.Interfaces.ShapeCollectionLoadOptions	Представляет коллекцию фигур.
PowerPoint.Interfaces.ShapeCollectionUpdateData	Интерфейс для обновления данных объекта ShapeCollection для использования в shapeCollection.set({ ... }).
PowerPoint.Interfaces.ShapeData	Интерфейс, описывающий данные, возвращаемые путем вызова shape.toJSON().
PowerPoint.Interfaces.ShapeFillData	Интерфейс, описывающий данные, возвращаемые путем вызова shapeFill.toJSON().
PowerPoint.Interfaces.ShapeFillUpdateData	Интерфейс для обновления данных объекта ShapeFill для использования в shapeFill.set({ ... }).
PowerPoint.Interfaces.ShapeFontData	Интерфейс, описывающий данные, возвращаемые путем вызова shapeFont.toJSON().
PowerPoint.Interfaces.ShapeFontUpdateData	Интерфейс для обновления данных объекта ShapeFont для использования в shapeFont.set({ ... }).
PowerPoint.Interfaces.ShapeLineFormatData	Интерфейс, описывающий данные, возвращаемые путем вызова shapeLineFormat.toJSON().
PowerPoint.Interfaces.ShapeLineFormatUpdateData	Интерфейс для обновления данных объекта ShapeLineFormat для использования в shapeLineFormat.set({ ... }).
PowerPoint.Interfaces.ShapeLoadOptions	Представляет одну фигуру на слайде.
PowerPoint.Interfaces.ShapeScopedCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова shapeScopedCollection.toJSON().
PowerPoint.Interfaces.ShapeScopedCollectionUpdateData	Интерфейс для обновления данных объекта ShapeScopedCollection для использования в shapeScopedCollection.set({ ... }).
PowerPoint.Interfaces.ShapeUpdateData	Интерфейс для обновления данных объекта Shape для использования в shape.set({ ... }).
PowerPoint.Interfaces.SlideCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова slideCollection.toJSON().
PowerPoint.Interfaces.SlideCollectionLoadOptions	Представляет коллекцию слайдов в презентации.
PowerPoint.Interfaces.SlideCollectionUpdateData	Интерфейс для обновления данных объекта SlideCollection для использования в slideCollection.set({ ... }).
PowerPoint.Interfaces.SlideData	Интерфейс, описывающий данные, возвращаемые путем вызова slide.toJSON().
PowerPoint.Interfaces.SlideLayoutCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова slideLayoutCollection.toJSON().
PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions	Представляет коллекцию макетов, предоставляемых образцом слайдов для слайдов.
PowerPoint.Interfaces.SlideLayoutCollectionUpdateData	Интерфейс для обновления данных объекта SlideLayoutCollection для использования в slideLayoutCollection.set({ ... }).
PowerPoint.Interfaces.SlideLayoutData	Интерфейс, описывающий данные, возвращаемые путем вызова slideLayout.toJSON().
PowerPoint.Interfaces.SlideLayoutLoadOptions	Представляет макет слайда.
PowerPoint.Interfaces.SlideLoadOptions	Представляет один слайд презентации.
PowerPoint.Interfaces.SlideMasterCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова slideMasterCollection.toJSON().
PowerPoint.Interfaces.SlideMasterCollectionLoadOptions	Представляет коллекцию образцов слайдов в презентации.
PowerPoint.Interfaces.SlideMasterCollectionUpdateData	Интерфейс для обновления данных объекта SlideMasterCollection для использования в slideMasterCollection.set({ ... }).
PowerPoint.Interfaces.SlideMasterData	Интерфейс, описывающий данные, возвращаемые путем вызова slideMaster.toJSON().
PowerPoint.Interfaces.SlideMasterLoadOptions	Представляет образец слайдов слайда.
PowerPoint.Interfaces.SlideScopedCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова slideScopedCollection.toJSON().
PowerPoint.Interfaces.SlideScopedCollectionUpdateData	Интерфейс для обновления данных объекта SlideScopedCollection для использования в slideScopedCollection.set({ ... }).
PowerPoint.Interfaces.TagCollectionData	Интерфейс, описывающий данные, возвращаемые путем вызова tagCollection.toJSON().
PowerPoint.Interfaces.TagCollectionLoadOptions	Представляет коллекцию тегов.
PowerPoint.Interfaces.TagCollectionUpdateData	Интерфейс для обновления данных объекта TagCollection для использования в tagCollection.set({ ... }).
PowerPoint.Interfaces.TagData	Интерфейс, описывающий данные, возвращаемые путем вызова tag.toJSON().
PowerPoint.Interfaces.TagLoadOptions	Представляет один тег на слайде.
PowerPoint.Interfaces.TagUpdateData	Интерфейс для обновления данных объекта Tag для использования в tag.set({ ... }).
PowerPoint.Interfaces.TextFrameData	Интерфейс, описывающий данные, возвращаемые путем вызова textFrame.toJSON().
PowerPoint.Interfaces.TextFrameUpdateData	Интерфейс для обновления данных объекта TextFrame для использования в textFrame.set({ ... }).
PowerPoint.Interfaces.TextRangeData	Интерфейс, описывающий данные, возвращаемые путем вызова textRange.toJSON().
PowerPoint.Interfaces.TextRangeUpdateData	Интерфейс для обновления данных объекта TextRange для использования в textRange.set({ ... }).

Перечисления

PowerPoint.ErrorCodes
PowerPoint.InsertSlideFormatting	Задает параметры форматирования при вставке слайдов.

Функции

PowerPoint.createPresentation(base64File)	Создает и открывает новую презентацию. При необходимости презентацию можно предварительно заполнить файлом .pptx в кодировке Base64. [ Набор API: PowerPointApi 1.1 ]
PowerPoint.run(batch)	Выполняет пакетный скрипт, выполняющий действия с объектной моделью PowerPoint, используя новый requestContext. При разрешении обещания все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.
PowerPoint.run(object, batch)	Выполняет пакетный скрипт, который выполняет действия в объектной модели PowerPoint, используя RequestContext ранее созданного объекта API. При разрешении обещания все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.
PowerPoint.run(objects, batch)	Выполняет пакетный скрипт, который выполняет действия в объектной модели PowerPoint, используя RequestContext ранее созданных объектов API.

Сведения о функции

PowerPoint.createPresentation(base64File)

Создает и открывает новую презентацию. При необходимости презентацию можно предварительно заполнить файлом .pptx в кодировке Base64.

[ Набор API: PowerPointApi 1.1 ]

export function createPresentation(base64File?: string): Promise<void>;

Параметры

base64File

string

Необязательный параметр. Файл .pptx в кодировке Base64. По умолчанию используется значение NULL.

Возвращаемое значение

Promise<void>

Примеры

const myFile = <HTMLInputElement>document.getElementById("file");
const reader = new FileReader();

reader.onload = (event) => {
  // Remove the metadata before the base64-encoded string.
  const startIndex = reader.result.toString().indexOf("base64,");
  const copyBase64 = reader.result.toString().substr(startIndex + 7);

  PowerPoint.createPresentation(copyBase64);
};

// Read in the file as a data URL so we can parse the base64-encoded string.
reader.readAsDataURL(myFile.files[0]);

PowerPoint.run(batch)

Выполняет пакетный скрипт, выполняющий действия с объектной моделью PowerPoint, используя новый requestContext. При разрешении обещания все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.

export function run<T>(batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>): OfficeExtension.IPromise<T>;

Параметры

batch

(context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>

Функция, которая принимает requestContext и возвращает обещание (как правило, только результат "context.sync()"). Параметр контекста упрощает запросы к приложению PowerPoint. Так как надстройка Office и приложение PowerPoint выполняются в двух разных процессах, requestContext требуется для получения доступа к объектной модели PowerPoint из надстройки.

Возвращаемое значение

OfficeExtension.IPromise<T>

PowerPoint.run(object, batch)

Выполняет пакетный скрипт, который выполняет действия в объектной модели PowerPoint, используя RequestContext ранее созданного объекта API. При разрешении обещания все отслеживаемые объекты, которые были автоматически выделены во время выполнения, будут освобождены.

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>): OfficeExtension.IPromise<T>;

Параметры

object

OfficeExtension.ClientObject

Ранее созданный объект API. Пакет будет использовать тот же объект RequestContext, что и переданный объект. Это означает, что все изменения, примененные к объекту, будут приняты командой context.sync().

batch

(context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>

Функция, которая принимает requestContext и возвращает обещание (как правило, только результат "context.sync()"). Параметр контекста упрощает запросы к приложению PowerPoint. Так как надстройка Office и приложение PowerPoint выполняются в двух разных процессах, requestContext требуется для получения доступа к объектной модели PowerPoint из надстройки.

Возвращаемое значение

OfficeExtension.IPromise<T>

PowerPoint.run(objects, batch)

Выполняет пакетный скрипт, который выполняет действия в объектной модели PowerPoint, используя RequestContext ранее созданных объектов API.

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>): OfficeExtension.IPromise<T>;

Параметры

objects

OfficeExtension.ClientObject[]

Массив ранее созданных объектов API. Массив будет проверен, чтобы убедиться, что все объекты имеют один и тот же контекст. Пакет будет использовать этот общий requestContext, что означает, что любые изменения, примененные к этим объектам, будут приняты командой context.sync().

batch

(context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>

Функция, которая принимает requestContext и возвращает обещание (как правило, только результат "context.sync()"). Параметр контекста упрощает запросы к приложению PowerPoint. Так как надстройка Office и приложение PowerPoint выполняются в двух разных процессах, requestContext требуется для получения доступа к объектной модели PowerPoint из надстройки.

Возвращаемое значение

OfficeExtension.IPromise<T>