PowerPoint.ThemeColorScheme class

Пакет:

powerpoint

Представляет цветовую схему темы.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: PowerPointApi 1.10

Используется

• PowerPoint.Slide: themeColorScheme
• PowerPoint.SlideLayout: themeColorScheme
• PowerPoint.SlideMaster: themeColorScheme

Примеры

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

// Resets accent colors on the first slide to default Office theme values and updates swatches if present.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.slides.getItemAt(0);
  const colorScheme: PowerPoint.ThemeColorScheme = slide.themeColorScheme;

  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent1, "#4472C4");
  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent2, "#ED7D31");
  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent3, "#A9D18E");
  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent4, "#FFC000");
  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent5, "#5B9BD5");
  colorScheme.setThemeColor(PowerPoint.ThemeColor.accent6, "#70AD47");
  await context.sync();

  await updateSwatches(context, slide);
  console.log("Accent colors reset to default Office theme values on slide 1.");
});

Свойства

context

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

Методы

getThemeColor(color)	Возвращает значение цвета для указанного ThemeColorобъекта .
getThemeColor(color)	Возвращает значение цвета для указанного ThemeColorобъекта .
setThemeColor(color, rgbColor)	Задает значение цвета для указанного ThemeColorобъекта .
setThemeColor(color, rgbColor)	Задает значение цвета для указанного ThemeColorобъекта .
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.ThemeColorScheme объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.ThemeColorSchemeData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

PowerPoint.RequestContext

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

getThemeColor(color)

Возвращает значение цвета для указанного ThemeColorобъекта .

getThemeColor(color: PowerPoint.ThemeColor): OfficeExtension.ClientResult<string>;

Параметры

color

PowerPoint.ThemeColor

Цвет темы.

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

OfficeExtension.ClientResult<string>

Значение цвета в формате #RRGGBB (например, FFA500).

Комментарии

Набор API: PowerPointApi 1.10

getThemeColor(color)

Возвращает значение цвета для указанного ThemeColorобъекта .

getThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"): OfficeExtension.ClientResult<string>;

Параметры

color

"Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"

Цвет темы.

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

OfficeExtension.ClientResult<string>

Значение цвета в формате #RRGGBB (например, FFA500).

Комментарии

Набор API: PowerPointApi 1.10

setThemeColor(color, rgbColor)

Задает значение цвета для указанного ThemeColorобъекта .

setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string): void;

Параметры

color

PowerPoint.ThemeColor

Цвет темы.

rgbColor

string

Значение цвета в #RRGGBB формате (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").

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

void

Комментарии

Набор API: PowerPointApi 1.10

setThemeColor(color, rgbColor)

Задает значение цвета для указанного ThemeColorобъекта .

setThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2", rgbColor: string): void;

Параметры

color

"Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"

Цвет темы.

rgbColor

string

Значение цвета в #RRGGBB формате (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").

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

void

Комментарии

Набор API: PowerPointApi 1.10

toJSON()

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

toJSON(): {
            [key: string]: string;
        };

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

{ [key: string]: string; }