Office.DialogOptions interface

Paket:

office

Stellt Optionen für die Anzeige eines Dialogfelds bereit.

Eigenschaften

asyncContext	Ein benutzerdefiniertes Element eines beliebigen Typs, das unverändert in der asyncContext-Eigenschaft des AsyncResult-Objekts zurückgegeben wird, das an einen Rückruf übergeben wird.
displayInIframe	Bestimmt, ob das Dialogfeld in einem IFrame angezeigt werden soll. Diese Einstellung gilt nur für Office im Web und wird von anderen Plattformen ignoriert. Bei false (Standard) wird das Dialogfeld als neues Browserfenster (Popup) angezeigt. Empfohlen für Authentifizierungsseiten, die nicht in einem IFrame angezeigt werden können. Wenn true, wird das Dialogfeld als unverankerte Überlagerung mit einem IFrame angezeigt. Dies ist für die Benutzererfahrung und die Leistung am besten.
height	Definiert die Höhe des Dialogfelds als Prozentsatz der aktuellen Anzeige. Der Standardwert lautet 80 %. Mindestens 250px.
promptBeforeOpen	Bestimmt, ob dem Benutzer das Popupblockerdialogfeld angezeigt wird. Der Standardwert ist true. true – Das Framework zeigt ein Popupfenster zum Auslösen der Navigation und zur Umgehung des Popupblockers des Browsers an. false – Das Dialogfeld wird nicht angezeigt, und der Entwickler muss Popups (durch Bereitstellen einer Benutzeroberfläche zum Auslösen der Navigation) verwalten.
width	Definiert die Breite des Dialogfelds als Prozentsatz der aktuellen Anzeige. Der Standardwert lautet 80 %. Mindestens 150px.

Details zur Eigenschaft

asyncContext

Ein benutzerdefiniertes Element eines beliebigen Typs, das unverändert in der asyncContext-Eigenschaft des AsyncResult-Objekts zurückgegeben wird, das an einen Rückruf übergeben wird.

asyncContext?: any

Eigenschaftswert

any

displayInIframe

Bestimmt, ob das Dialogfeld in einem IFrame angezeigt werden soll. Diese Einstellung gilt nur für Office im Web und wird von anderen Plattformen ignoriert. Bei false (Standard) wird das Dialogfeld als neues Browserfenster (Popup) angezeigt. Empfohlen für Authentifizierungsseiten, die nicht in einem IFrame angezeigt werden können. Wenn true, wird das Dialogfeld als unverankerte Überlagerung mit einem IFrame angezeigt. Dies ist für die Benutzererfahrung und die Leistung am besten.

displayInIframe?: boolean

Eigenschaftswert

boolean

height

Definiert die Höhe des Dialogfelds als Prozentsatz der aktuellen Anzeige. Der Standardwert lautet 80 %. Mindestens 250px.

height?: number,

Eigenschaftswert

number

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 and how to use that handler to close 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);
        });
    }
);

promptBeforeOpen

Bestimmt, ob dem Benutzer das Popupblockerdialogfeld angezeigt wird. Der Standardwert ist true.

true – Das Framework zeigt ein Popupfenster zum Auslösen der Navigation und zur Umgehung des Popupblockers des Browsers an. false – Das Dialogfeld wird nicht angezeigt, und der Entwickler muss Popups (durch Bereitstellen einer Benutzeroberfläche zum Auslösen der Navigation) verwalten.

promptBeforeOpen?: boolean;

Eigenschaftswert

boolean

width

Definiert die Breite des Dialogfelds als Prozentsatz der aktuellen Anzeige. Der Standardwert lautet 80 %. Mindestens 150px.

width?: number,

Eigenschaftswert

number

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 and how to use that handler to close 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);
        });
    }
);