PowerPoint.SlideBackground class

Пакет:

powerpoint

Представляет фон слайда.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: PowerPointApi 1.10 ]

Примеры

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

Свойства

areBackgroundGraphicsHidden	Указывает, скрывается ли фоновая заливка макета слайда или отображает фоновые графические объекты из master слайда.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
fill	Возвращает форматирование заполнения фона.
isMasterBackgroundFollowed	Указывает, следует ли фон слайда за фоном master.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
reset()	Сбрасывает форматирование заливки фона слайда.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.SlideBackground объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.SlideBackgroundData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

areBackgroundGraphicsHidden

Указывает, скрывается ли фоновая заливка макета слайда или отображает фоновые графические объекты из master слайда.

areBackgroundGraphicsHidden: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: PowerPointApi 1.10 ]

context

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

context: RequestContext;

Значение свойства

PowerPoint.RequestContext

fill

Возвращает форматирование заполнения фона.

readonly fill: PowerPoint.SlideBackgroundFill;

Значение свойства

PowerPoint.SlideBackgroundFill

Комментарии

[ Набор API: PowerPointApi 1.10 ]

Примеры

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

isMasterBackgroundFollowed

Указывает, следует ли фон слайда за фоном master.

isMasterBackgroundFollowed: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: PowerPointApi 1.10 ]

Сведения о методе

load(options)

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

load(options?: PowerPoint.Interfaces.SlideBackgroundLoadOptions): PowerPoint.SlideBackground;

Параметры

options

PowerPoint.Interfaces.SlideBackgroundLoadOptions

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

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

PowerPoint.SlideBackground

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

PowerPoint.SlideBackground

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

PowerPoint.SlideBackground

reset()

Сбрасывает форматирование заливки фона слайда.

reset(): void;

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

void

Комментарии

[ Набор API: PowerPointApi 1.10 ]

toJSON()

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

toJSON(): PowerPoint.Interfaces.SlideBackgroundData;

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

PowerPoint.Interfaces.SlideBackgroundData