Office.DialogParentMessageReceivedEventArgs interface

Enthält Informationen zur Nachricht von der übergeordneten Seite, die das DialogParentMessageReceived Ereignis ausgelöst hat.

Verwenden Sie zum Hinzufügen eines Ereignishandlers für das DialogParentMessageReceived Ereignis die addHandlerAsync Methode des Office.UI-Objekts .

Hinweise

Verwendet von

Beispiele

// The following example provides information about the message from the parent page.
Office.onReady(() => {
    Office.context.ui.addHandlerAsync(Office.EventType.DialogMessageReceived, onMessageFromParent);
});

function onMessageFromParent(args: Office.DialogParentMessageReceivedEventArgs) {
    const eventType = args.type;
    const origin = args.origin;
    const messageFromParent = args.message;
    console.log(`${eventType} event occurred. Message received from ${origin}: ${messageFromParent}`);
}

Eigenschaften

message

Ruft den Inhalt der Nachricht ab, die von der übergeordneten Seite gesendet wurde, wobei es sich um eine beliebige Zeichenfolge oder um Zeichenfolgen handeln kann.

origin

Ruft die Domäne der übergeordneten Seite ab, die aufgerufen hat Dialog.messageChild.

type

Ruft einen Office.EventType-Enumerationswert ab, der den Typ des ausgelösten Ereignisses angibt.

Details zur Eigenschaft

message

Ruft den Inhalt der Nachricht ab, die von der übergeordneten Seite gesendet wurde, wobei es sich um eine beliebige Zeichenfolge oder um Zeichenfolgen handeln kann.

message: string;

Eigenschaftswert

string

origin

Ruft die Domäne der übergeordneten Seite ab, die aufgerufen hat Dialog.messageChild.

origin: string | undefined;

Eigenschaftswert

string | undefined

Hinweise

Anforderungssatz: DialogOrigin 1.1. Die Eigenschaft befindet sich undefined auf Clients, die diesen Anforderungssatz nicht unterstützen.

type

Ruft einen Office.EventType-Enumerationswert ab, der den Typ des ausgelösten Ereignisses angibt.

type: EventType;

Eigenschaftswert