Office.OfficeTheme interface

包:

office

提供了访问 Office 主题颜色的属性。

使用 Office 主题颜色，可以将加载项的配色方案与用户选择的当前 Office 主题进行协调。 用户通过文件>帐户或 Office 帐户> Office 主题在 Office 应用程序中设置主题。 然后，所选主题将应用于所有 Office 应用程序。 使用 Office 主题颜色适用于邮件和任务窗格外接程序。

有关 Office 主题的详细信息，请参阅 更改 Microsoft 365 的外观。

注解

支持的应用程序（按平台）

	Office 网页版	Windows 版 Office	Mac 版 Office	iOS 版 Office	Android 版 Office
Excel	支持	支持	支持	支持	不可用
Outlook	支持	支持	不可用	不可用	不可用
PowerPoint	支持	支持	支持	支持	不可用
Word	支持	支持	支持	支持	不可用

重要提示：在 Outlook 中，从 邮箱要求集 1.14 开始支持 Office 主题 API。 实现 基于事件的激活的 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

注解

重要提示：Outlook isDarkTheme 中尚不支持 属性。

themeId

获取当前所选的 Office 主题。

themeId: ThemeId;

属性值

Office.ThemeId

注解

重要提示：Outlook themeId 中尚不支持 属性。