Office.OfficeTheme interface

Paket:
office

Bietet Zugriff auf die Eigenschaften für Office-Farbdesigns.

Durch die Verwendung von Office-Designfarben können Sie das Farbschema Ihres Add-Ins mit dem aktuellen vom Benutzer ausgewählten Office-Design koordinieren. Der Benutzer legt in einer Office-Anwendung ein Design über das>Dateikonto oder dasOffice-Konto-Office-Design> fest. Das ausgewählte Design wird dann auf alle Office-Anwendungen angewendet. Using Office theme colors is appropriate for mail and task pane add-ins.

Weitere Informationen zu Office-Designs finden Sie unter Ändern des Aussehens und Verhaltens von Microsoft 365.

Hinweise

Unterstützte Anwendungen nach Plattform

Office im Web Office unter Windows Office für Mac Office unter iOS Office unter Android
Excel Unterstützt Unterstützt Unterstützt Unterstützt Nicht verfügbar
Outlook Unterstützt Unterstützt Unterstützt Nicht verfügbar Nicht verfügbar
PowerPoint Unterstützt Unterstützt Unterstützt Unterstützt Nicht verfügbar
Word Unterstützt Unterstützt Unterstützt Unterstützt Nicht verfügbar

Wichtig: In Outlook wird die Office-Design-API ab Postfachanforderungssatz 1.14 unterstützt. Es wird in Outlook-Add-Ins, die eine ereignisbasierte Aktivierung implementieren, nicht unterstützt.

Verwendet von

Beispiele

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

Eigenschaften

bodyBackgroundColor

Ruft die Hintergrundfarbe für den Textkörper des Office-Designs als hexadezimales Farbtriplett ab (z. B. "#FFA500").
bodyForegroundColor

Ruft die Vordergrundfarbe des Office-Designtextkörpers als hexadezimales Farbtriplett ab (z. B. "#FFA500").
controlBackgroundColor

Ruft die Hintergrundfarbe des Office-Designsteuerelements als hexadezimales Farbtriplett ab (z. B. "#FFA500").
controlForegroundColor

Ruft die Vordergrundfarbe des Office-Designsteuerelements als hexadezimales Farbtriplett ab (z. B. "#FFA500").
fluentThemeData

Ruft das native Office-Hostdesign ab.
isDarkTheme

Gibt zurück true , ob das aktuell ausgewählte Office-Design Schwarz (dunkler Modus) oder "Dunkelgrau" ist.
themeId

Ruft das aktuell ausgewählte Office-Design ab.

Details zur Eigenschaft

bodyBackgroundColor

Ruft die Hintergrundfarbe für den Textkörper des Office-Designs als hexadezimales Farbtriplett ab (z. B. "#FFA500").

bodyBackgroundColor: string;

Eigenschaftswert

string

bodyForegroundColor

Ruft die Vordergrundfarbe des Office-Designtextkörpers als hexadezimales Farbtriplett ab (z. B. "#FFA500").

bodyForegroundColor: string;

Eigenschaftswert

string

controlBackgroundColor

Ruft die Hintergrundfarbe des Office-Designsteuerelements als hexadezimales Farbtriplett ab (z. B. "#FFA500").

controlBackgroundColor: string;

Eigenschaftswert

string

controlForegroundColor

Ruft die Vordergrundfarbe des Office-Designsteuerelements als hexadezimales Farbtriplett ab (z. B. "#FFA500").

controlForegroundColor: string;

Eigenschaftswert

string

fluentThemeData

Ruft das native Office-Hostdesign ab.

fluentThemeData?: object;

Eigenschaftswert

object

Hinweise

Wichtig: Die fluentThemeData Eigenschaft wird nur in Excel-, PowerPoint- und Word-Desktopclients für Windows unterstützt.

isDarkTheme

Gibt zurück true , ob das aktuell ausgewählte Office-Design Schwarz (dunkler Modus) oder "Dunkelgrau" ist.

isDarkTheme: boolean;

Eigenschaftswert

boolean

Hinweise

Wichtig: Die isDarkTheme Eigenschaft wird in Outlook nicht unterstützt. Um das aktuelle Design in Outlook zu ermitteln, verwenden Sie stattdessen die body*Colorcontrol*Color und-Eigenschaften. Um Designänderungen automatisch zu erkennen, verwenden Sie die addHandlerAsync-Methode , um einen Ereignishandler für das OfficeThemeChanged-Ereignis zu erstellen.

themeId

Ruft das aktuell ausgewählte Office-Design ab.

themeId: ThemeId;

Eigenschaftswert

Office.ThemeId

Hinweise

Wichtig: Die themeId Eigenschaft wird in Outlook nicht unterstützt. Um das aktuelle Design in Outlook zu ermitteln, verwenden Sie stattdessen die body*Colorcontrol*Color und-Eigenschaften. Um Designänderungen automatisch zu erkennen, verwenden Sie die addHandlerAsync-Methode , um einen Ereignishandler für das OfficeThemeChanged-Ereignis zu erstellen.