Office.OfficeTheme interface

Pacote:

office

Fornece acesso às propriedades de cores de temas do Office.

Utilizar as cores do tema do Office permite-lhe coordenar o esquema de cores do seu suplemento com o tema atual do Office selecionado pelo utilizador. O utilizador define um tema numa aplicação do Office através daContade Ficheiro> oudo Tema do Officeda Conta> do Office. Em seguida, o tema selecionado é aplicado em todas as aplicações do Office. Usar cores de temas do Office é apropriado suplementos de email e painéis de tarefas.

Para obter mais informações sobre temas do Office, consulte Alterar o aspeto e funcionalidade do Microsoft 365.

Comentários

Aplicações suportadas, por plataforma

	Office na Web	Office no Windows	Office no Mac	Office no iOS	Outlook no Android
Excel	Com suporte	Com suporte	Com suporte	Com suporte	Não disponível
Outlook	Com suporte	Com suporte	Não disponível	Não disponível	Não disponível
PowerPoint	Com suporte	Com suporte	Com suporte	Com suporte	Não disponível
Word	Com suporte	Com suporte	Com suporte	Com suporte	Não disponível

Importante: no Outlook, a API de tema do Office é suportada a partir do requisito caixa de correio definido como 1.14. Não é suportado nos suplementos do Outlook que implementam a ativação baseada em eventos.

Exemplos

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

Propriedades

bodyBackgroundColor	Obtém a cor de fundo do corpo do tema do Office como um triplet de cor hexadecimal (por exemplo, "#FFA500").
bodyForegroundColor	Obtém a cor de primeiro plano do corpo do tema do Office como um triplet de cor hexadecimal (por exemplo, "#FFA500").
controlBackgroundColor	Obtém a cor de fundo do controlo de tema do Office como um triplet de cor hexadecimal (por exemplo, "#FFA500").
controlForegroundColor	Obtém a cor de primeiro plano do controlo de tema do Office como um triplet de cor hexadecimal (por exemplo, "#FFA500").
isDarkTheme	Devolve true se o tema do Office atualmente selecionado for Preto (modo escuro) ou Cinzento Escuro.
themeId	Obtém o tema do Office que está atualmente selecionado.

Detalhes da propriedade

bodyBackgroundColor

Obtém a cor de fundo do corpo do tema do Office como um triplet de cor hexadecimal (por exemplo, "#FFA500").

bodyBackgroundColor: string;

Valor da propriedade

string

bodyForegroundColor

Obtém a cor de primeiro plano do corpo do tema do Office como um triplet de cor hexadecimal (por exemplo, "#FFA500").

bodyForegroundColor: string;

Valor da propriedade

string

controlBackgroundColor

Obtém a cor de fundo do controlo de tema do Office como um triplet de cor hexadecimal (por exemplo, "#FFA500").

controlBackgroundColor: string;

Valor da propriedade

string

controlForegroundColor

Obtém a cor de primeiro plano do controlo de tema do Office como um triplet de cor hexadecimal (por exemplo, "#FFA500").

controlForegroundColor: string;

Valor da propriedade

string

isDarkTheme

Devolve true se o tema do Office atualmente selecionado for Preto (modo escuro) ou Cinzento Escuro.

isDarkTheme: boolean;

Valor da propriedade

boolean

Comentários

Importante: a isDarkTheme propriedade ainda não é suportada no Outlook.

themeId

Obtém o tema do Office que está atualmente selecionado.

themeId: ThemeId;

Valor da propriedade

Office.ThemeId

Comentários

Importante: a themeId propriedade ainda não é suportada no Outlook.