Office.OfficeTheme interface

Пакет:

office

Предоставляет доступ к свойствам цветов темы Office.

С помощью цветов темы Office можно согласовать цветовую схему надстройки с текущей темой Office, выбранной пользователем. Пользователь задает тему в приложении Office с помощью файловой>учетной записи илитемы officeучетной записи> Office. Затем выбранная тема применяется во всех приложениях Office. Using Office theme colors is appropriate for mail and task pane add-ins.

Дополнительные сведения о темах Office см. в статье Изменение внешнего вида Microsoft 365.

Комментарии

Поддерживаемые приложения по платформам

	Office в Интернете	Office для Windows	Office для Mac	Office для iOS	Office для Android
Excel	Поддерживается	Поддерживается	Поддерживается	Поддерживается	Недоступно
Outlook	Поддерживается	Поддерживается	Недоступно	Недоступно	Недоступно
PowerPoint	Поддерживается	Поддерживается	Поддерживается	Поддерживается	Недоступно
Word	Поддерживается	Поддерживается	Поддерживается	Поддерживается	Недоступно

Важно! В Outlook API темы Office поддерживается, начиная с набора обязательных почтовых ящиков 1.14. Он не поддерживается в надстройках Outlook, которые реализуют активацию на основе событий.

Примеры

function applyOfficeTheme() {
    // Identify the current Office theme in use.
    const currentOfficeTheme = Office.context.officeTheme.themeId;

    if (currentOfficeTheme === Office.ThemeId.Colorful || currentOfficeTheme === Office.ThemeId.White) {
        console.log("No changes required.");
    }

    // Get the colors of the current Office theme.
    const bodyBackgroundColor = Office.context.officeTheme.bodyBackgroundColor;
    const bodyForegroundColor = Office.context.officeTheme.bodyForegroundColor;
    const controlBackgroundColor = Office.context.officeTheme.controlBackgroundColor;
    const controlForegroundColor = Office.context.officeTheme.controlForegroundColor;

    // Apply theme colors to a CSS class.
    $("body").css("background-color", bodyBackgroundColor);

    if (Office.context.officeTheme.isDarkTheme()) {
        $("h1").css("color", controlForegroundColor);
    }
}

Свойства

bodyBackgroundColor	Получает цвет фона основного текста темы Office в виде шестнадцатеричной триплеты (например, "#FFA500").
bodyForegroundColor	Возвращает цвет основного плана темы Office в виде шестнадцатеричной триплеты (например, "#FFA500").
controlBackgroundColor	Возвращает цвет фона элемента управления темой Office в виде шестнадцатеричной триплеты (например, "#FFA500").
controlForegroundColor	Возвращает цвет переднего плана элемента управления темой Office в виде шестнадцатеричного триплета цвета (например, "#FFA500").
isDarkTheme	Возвращает значение true , если выбранная в данный момент тема Office : Черная (темный режим) или Темно-серая.
themeId	Возвращает выбранную тему Office.

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

bodyBackgroundColor

Получает цвет фона основного текста темы Office в виде шестнадцатеричной триплеты (например, "#FFA500").

bodyBackgroundColor: string;

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

string

bodyForegroundColor

Возвращает цвет основного плана темы Office в виде шестнадцатеричной триплеты (например, "#FFA500").

bodyForegroundColor: string;

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

string

controlBackgroundColor

Возвращает цвет фона элемента управления темой Office в виде шестнадцатеричной триплеты (например, "#FFA500").

controlBackgroundColor: string;

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

string

controlForegroundColor

Возвращает цвет переднего плана элемента управления темой Office в виде шестнадцатеричного триплета цвета (например, "#FFA500").

controlForegroundColor: string;

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

string

isDarkTheme

Возвращает значение true , если выбранная в данный момент тема Office : Черная (темный режим) или Темно-серая.

isDarkTheme: boolean;

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

boolean

Комментарии

Важно! Свойство isDarkTheme еще не поддерживается в Outlook.

themeId

Возвращает выбранную тему Office.

themeId: ThemeId;

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

Office.ThemeId

Комментарии

Важно! Свойство themeId еще не поддерживается в Outlook.