Compartir a través de

Office.OfficeTheme interface

  • Referencia
Paquete:
office

Proporciona acceso a las propiedades de los colores del tema de Office.

El uso de colores de tema de Office le permite coordinar la combinación de colores del complemento con el tema de Office actual seleccionado por el usuario. El usuario establece un tema en una aplicación de Office a través dela cuentade archivo> oel tema de Officede la cuenta> de Office. El tema seleccionado se aplica a todas las aplicaciones de Office. El uso de colores del tema de Office es idóneo para los complementos de correo y panel de tareas.

Para obtener más información sobre los temas de Office, vea Cambiar la apariencia de Microsoft 365.

Comentarios

Aplicaciones admitidas, por plataforma

Office en la web Office en Windows Office en Mac Office en iOS Office para Android
Excel Compatible Compatible Compatible Compatible No disponible
Outlook Compatible Compatible No disponible No disponible No disponible
PowerPoint Compatible Compatible Compatible Compatible No disponible
Word Compatible Compatible Compatible Compatible No disponible

Importante: En Outlook, se admite la API de tema de Office a partir del conjunto de requisitos de buzón 1.14. No se admite en complementos de Outlook que implementan la activación basada en eventos.

Ejemplos

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

Propiedades

bodyBackgroundColor

Obtiene el color de fondo del cuerpo del tema de Office como un triplete de color hexadecimal (por ejemplo, "#FFA500").
bodyForegroundColor

Obtiene el color de primer plano del cuerpo del tema de Office como un triplete de color hexadecimal (por ejemplo, "#FFA500").
controlBackgroundColor

Obtiene el color de fondo del control de tema de Office como un triplete de color hexadecimal (por ejemplo, "#FFA500").
controlForegroundColor

Obtiene el color de primer plano del control de tema de Office como un triplete de color hexadecimal (por ejemplo, "#FFA500").
isDarkTheme

Devuelve true si el tema de Office seleccionado actualmente es Negro (modo oscuro) o Gris oscuro.
themeId

Obtiene el tema de Office que está seleccionado actualmente.

Detalles de las propiedades

bodyBackgroundColor

Obtiene el color de fondo del cuerpo del tema de Office como un triplete de color hexadecimal (por ejemplo, "#FFA500").

bodyBackgroundColor: string;

Valor de propiedad

string

bodyForegroundColor

Obtiene el color de primer plano del cuerpo del tema de Office como un triplete de color hexadecimal (por ejemplo, "#FFA500").

bodyForegroundColor: string;

Valor de propiedad

string

controlBackgroundColor

Obtiene el color de fondo del control de tema de Office como un triplete de color hexadecimal (por ejemplo, "#FFA500").

controlBackgroundColor: string;

Valor de propiedad

string

controlForegroundColor

Obtiene el color de primer plano del control de tema de Office como un triplete de color hexadecimal (por ejemplo, "#FFA500").

controlForegroundColor: string;

Valor de propiedad

string

isDarkTheme

Devuelve true si el tema de Office seleccionado actualmente es Negro (modo oscuro) o Gris oscuro.

isDarkTheme: boolean;

Valor de propiedad

boolean

Comentarios

Importante: La isDarkTheme propiedad aún no se admite en Outlook.

themeId

Obtiene el tema de Office que está seleccionado actualmente.

themeId: ThemeId;

Valor de propiedad

Office.ThemeId

Comentarios

Importante: La themeId propiedad aún no se admite en Outlook.