Office.DialogParentMessageReceivedEventArgs interface

Предоставляет сведения о сообщении с родительской страницы, которая вызвала DialogParentMessageReceived событие.

Чтобы добавить обработчик DialogParentMessageReceived событий, используйте addHandlerAsync метод объекта Office.UI .

Комментарии

Используется

Примеры

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

Свойства

message

Получает содержимое сообщения, отправленного с родительской страницы, которое может быть любой строкой или строковым значением.

origin

Получает домен родительской страницы, вызванной Dialog.messageChild.

type

Получает значение перечисления Office.EventType , определяющее тип возникшего события.

Сведения о свойстве

message

Получает содержимое сообщения, отправленного с родительской страницы, которое может быть любой строкой или строковым значением.

message: string;

Значение свойства

string

origin

Получает домен родительской страницы, вызванной Dialog.messageChild.

origin: string | undefined;

Значение свойства

string | undefined

Комментарии

Набор требований: DialogOrigin 1.1. Свойство находится undefined на клиентах, которые не поддерживают этот набор требований.

type

Получает значение перечисления Office.EventType , определяющее тип возникшего события.

type: EventType;

Значение свойства