Office.DialogOptions interface

Пакет:

office

Предоставляет параметры отображения диалогового окна.

Свойства

asyncContext	Определяемый пользователем элемент любого типа, возвращаемый без изменений в свойстве asyncContext объекта AsyncResult, который передается обратному вызову.
displayInIframe	Определяет, должно ли диалоговое окно отображаться в IFrame. Этот параметр применим только в Office в Интернете и игнорируется другими платформами. Если значение равно false (по умолчанию), диалоговое окно будет отображаться как новое окно браузера (всплывающее окно). Рекомендуется использовать для страниц проверки подлинности, которые не могут отображаться в IFrame. Если значение равно true, диалоговое окно будет отображаться как плавающее наложение с IFrame. Этот вариант удобнее для пользователей и производительнее.
height	Определяет высоту диалогового окна в процентном отношении к текущему экрану. Значение по умолчанию: 80 %. Минимальный размер: 250 пикселей.
promptBeforeOpen	Определяет, будет ли отображаться диалоговое окно блокировки всплывающих окон для пользователя. Значение по умолчанию — true. true — платформа отображает всплывающее окно, чтобы запустить навигацию и обойти блокировщик всплывающих окон браузера. false — диалоговое окно не отображается. Всплывающие окна должны обрабатываться разработчиком (путем предоставления артефакта пользовательского интерфейса для запуска навигации).
width	Определяет ширину диалогового окна в процентном отношении к текущему экрану. Значение по умолчанию: 80 %. Минимальный размер: 150 пикселей.

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

asyncContext

Определяемый пользователем элемент любого типа, возвращаемый без изменений в свойстве asyncContext объекта AsyncResult, который передается обратному вызову.

asyncContext?: any

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

any

displayInIframe

Определяет, должно ли диалоговое окно отображаться в IFrame. Этот параметр применим только в Office в Интернете и игнорируется другими платформами. Если значение равно false (по умолчанию), диалоговое окно будет отображаться как новое окно браузера (всплывающее окно). Рекомендуется использовать для страниц проверки подлинности, которые не могут отображаться в IFrame. Если значение равно true, диалоговое окно будет отображаться как плавающее наложение с IFrame. Этот вариант удобнее для пользователей и производительнее.

displayInIframe?: boolean

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

boolean

height

Определяет высоту диалогового окна в процентном отношении к текущему экрану. Значение по умолчанию: 80 %. Минимальный размер: 250 пикселей.

height?: number,

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

number

Примеры

// 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

Определяет, будет ли отображаться диалоговое окно блокировки всплывающих окон для пользователя. Значение по умолчанию — true.

true — платформа отображает всплывающее окно, чтобы запустить навигацию и обойти блокировщик всплывающих окон браузера. false — диалоговое окно не отображается. Всплывающие окна должны обрабатываться разработчиком (путем предоставления артефакта пользовательского интерфейса для запуска навигации).

promptBeforeOpen?: boolean;

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

boolean

width

Определяет ширину диалогового окна в процентном отношении к текущему экрану. Значение по умолчанию: 80 %. Минимальный размер: 150 пикселей.

width?: number,

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

number

Примеры

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