Office.UI interface

Fügt dem Objekt einen Ereignishandler mit dem angegebenen Ereignistyp hinzu.

addHandlerAsync(eventType: Office.EventType, handler: (result: DialogParentMessageReceivedEventArgs) => void, options: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssatz: DialogApi 1.2

Sie können mehrere Ereignishandler für den angegebenen Ereignistyp hinzufügen, solange der Name jeder Ereignishandlerfunktion eindeutig ist.

Fügt dem Objekt einen Ereignishandler mit dem angegebenen Ereignistyp hinzu.

addHandlerAsync(eventType: Office.EventType, handler: (result: DialogParentMessageReceivedEventArgs) => void, callback?: (result: AsyncResult<void>) => void): void;

Parameter

Gibt zurück

Hinweise

Anforderungssatz: DialogApi 1.2

Sie können mehrere Ereignishandler für den angegebenen Ereignistyp hinzufügen, solange der Name jeder Ereignishandlerfunktion eindeutig ist.

Beispiele

// The following example shows how to add an event handler for the DialogParentMessageReceived event.
Office.onReady(() => {
    Office.context.ui.addHandlerAsync(
        Office.EventType.DialogParentMessageReceived,
        onMessageFromParent,
        onRegisterMessageComplete
    );
});

function onMessageFromParent(arg) {
    const messageFromParent = JSON.parse(arg.message);
    document.querySelector('h1').textContent = messageFromParent.name;
}

function onRegisterMessageComplete(asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.log(asyncResult.error.message);
        return;
    }
}

Schließt den UI-Container, in dem der JavaScript-Code ausgeführt wird.

closeContainer(): void;

Gibt zurück

Hinweise

Anwendungen: Excel, Outlook (Mindestanforderung: Postfach 1.5), PowerPoint, Word

Anforderungssätze:

• DialogApi

• Mailbox 1.5

Das Verhalten dieser Methode wird wie folgt bestimmt:

• Aufgerufen von einer Befehlsschaltfläche ohne Benutzeroberfläche: Keine Auswirkung. Jedes über displayDialogAsync geöffnete Dialogfeld bleibt geöffnet.

• Aufgerufen aus einem Aufgabenbereich: Der Aufgabenbereich wird geschlossen. Jeder von displayDialogAsync geöffnete Dialog wird ebenfalls geschlossen. Wenn der Aufgabenbereich das Anheften unterstützt und vom Benutzer angeheftet wurde, wird die Anheftung aufgehoben.

• Von einer Modulerweiterung aufgerufen: Keine Auswirkung.

Beispiele

// The following example shows how to open a browser window to a download page and then close the add-in task pane.
Office.context.ui.openBrowserWindow("https://www.contoso.com/download");
Office.context.ui.closeContainer();

Zeigt ein Dialogfeld an, um Informationen vom Benutzer anzuzeigen oder zu sammeln oder um die Webnavigation zu erleichtern.

displayDialogAsync(startAddress: string, options?: DialogOptions, callback?: (result: AsyncResult<Dialog>) => void): void;

Parameter

Gibt zurück

Hinweise

Anwendungen: Excel, Outlook, PowerPoint, Word

Anforderungssätze:

• DialogApi

• Mailbox 1.4

Diese Methode ist im DialogApi-Anforderungssatz für Excel-, PowerPoint- oder Word-Add-Ins und im Postfach-Anforderungssatz 1.4 für Outlook verfügbar. Weitere Informationen zum Angeben eines Anforderungssatzes in Ihrem Manifest finden Sie unter Angeben von Office-Anwendungen und API-Anforderungen, wenn Sie das Nur-Add-In-Manifest verwenden. Wenn Sie das einheitliche Manifest für Microsoft 365 verwenden, finden Sie weitere Informationen unter Office-Add-Ins mit dem einheitlichen App-Manifest für Microsoft 365.

Wichtig:

• Die erste Seite muss sich in derselben Domäne wie die übergeordnete Seite befinden (der Parameter startAddress). Nachdem die Startseite geladen wurde, können Sie zu anderen Domänen wechseln.

• Jeder Seitenaufruf Office.context.ui.messageParent muss auch auf derselben Domäne wie die übergeordnete Seite erfolgen.

• Informationen zu Regeln, Einschränkungen und bewährten Methoden für die Office-Dialog-API finden Sie unter Bewährte Methoden und Regeln für die Office-Dialog-API.

• Informationen zu Fehlern und deren Behandlung finden Sie unter Behandeln von Fehlern und Ereignissen im Office-Dialogfeld.

• Legen Sie im Outlook im Web und im neuen Outlook unter Windows die Eigenschaft window.name nicht fest, wenn Sie ein Dialogfeld in Ihrem Add-In konfigurieren. Die window.name Eigenschaft wird von diesen Outlook-Clients verwendet, um die Funktionalität über Seitenumleitungen hinweg beizubehalten.

• In der Rückruffunktion, die an die displayDialogAsync-Methode übergeben wird, können Sie die Eigenschaften des AsyncResult-Objekts verwenden, um die folgenden Informationen zurückzugeben.

Beispiele

// The following example shows how to open a dialog with a specified size. It also shows
// how to register a function to handle the message when Office.UI.messageParent() is called
// in the dialog. The implementation of the processMessage() function is omitted.

Office.context.ui.displayDialogAsync("https://www.contoso.com/myDialog.html", { height: 30, width: 20 },
    (asyncResult) => {
        const dialog = asyncResult.value;
        dialog.addEventHandler(Office.EventType.DialogMessageReceived, (arg) => {
            dialog.close();
            processMessage(arg);
        });
    }
);

// The following example does the same thing in TypeScript.

Office.context.ui.displayDialogAsync("https://www.contoso.com/myDialog.html", { height: 30, width: 20 },
    (asyncResult: Office.AsyncResult) => {
        const dialog: Office.Dialog = asyncResult.value;
        dialog.addEventHandler(Office.EventType.DialogMessageReceived, (arg: string) => {
            dialog.close();
            processMessage(arg);
        });
    }
);

Zeigt ein Dialogfeld an, um Informationen vom Benutzer anzuzeigen oder zu sammeln oder um die Webnavigation zu erleichtern.

displayDialogAsync(startAddress: string, callback?: (result: AsyncResult<Dialog>) => void): void;

Parameter

Gibt zurück

Hinweise

Anwendungen: Excel, Outlook, PowerPoint, Word

Anforderungssätze:

• DialogApi

• Mailbox 1.4

Diese Methode ist im DialogApi-Anforderungssatz für Excel-, PowerPoint- oder Word-Add-Ins und im Postfach-Anforderungssatz 1.4 für Outlook verfügbar. Weitere Informationen zum Angeben eines Anforderungssatzes in Ihrem Manifest finden Sie unter Angeben von Office-Anwendungen und API-Anforderungen, wenn Sie das Nur-Add-In-Manifest verwenden. Wenn Sie das einheitliche Manifest für Microsoft 365 verwenden, finden Sie weitere Informationen unter Office-Add-Ins mit dem einheitlichen App-Manifest für Microsoft 365.

Wichtig:

• Die erste Seite muss sich in derselben Domäne wie die übergeordnete Seite befinden (der Parameter startAddress). Nachdem die Startseite geladen wurde, können Sie zu anderen Domänen wechseln.

• Jeder Seitenaufruf Office.context.ui.messageParent muss auch auf derselben Domäne wie die übergeordnete Seite erfolgen.

• Informationen zu Regeln, Einschränkungen und bewährten Methoden für die Office-Dialog-API finden Sie unter Bewährte Methoden und Regeln für die Office-Dialog-API.

• Informationen zu Fehlern und deren Behandlung finden Sie unter Behandeln von Fehlern und Ereignissen im Office-Dialogfeld.

• Legen Sie im Outlook im Web und im neuen Outlook unter Windows die Eigenschaft window.name nicht fest, wenn Sie ein Dialogfeld in Ihrem Add-In konfigurieren. Die window.name Eigenschaft wird von diesen Outlook-Clients verwendet, um die Funktionalität über Seitenumleitungen hinweg beizubehalten.

• In der Rückruffunktion, die an die displayDialogAsync-Methode übergeben wird, können Sie die Eigenschaften des AsyncResult-Objekts verwenden, um die folgenden Informationen zurückzugeben.

Übermittelt eine Nachricht vom Dialogfeld an die übergeordnete/öffnende Seite.

messageParent(message: string, messageOptions?: DialogMessageOptions): void;

Parameter

Gibt zurück

Hinweise

Anwendungen: Excel, Outlook, PowerPoint, Word

Anforderungssätze:

• DialogApi

• Mailbox 1.4

• Wenn der messageOptions Parameter verwendet wird, ist auch DialogOrigin 1.1 erforderlich.

Beispiele

// The following example shows how to send a JSON string to the parent. The profile object
// is returned from some website when a user signs into it.
function userProfileSignedIn(profile) {
    const profileMessage = {
        "name": profile.name,
        "email": profile.email,
    };
    Office.context.ui.messageParent(JSON.stringify(profileMessage));
}

Öffnet ein Browserfenster und lädt die angegebene URL.

openBrowserWindow(url: string): void;

Parameter

Gibt zurück

Hinweise

Anforderungssatz: OpenBrowserWindowApi 1.1

Beispiele

// The following example shows how to open a browser window to a download page and then close the add-in task pane.
Office.context.ui.openBrowserWindow("https://www.contoso.com/download");
Office.context.ui.closeContainer();