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;

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