Office.Addin interface

  • Ссылка
Пакет:
office

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

Комментарии

Набор обязательных элементов: SharedRuntime 1.1

Свойства

beforeDocumentCloseNotification

Представляет модальное диалоговое окно уведомлений, которое может отображаться при попытке пользователя закрыть документ. Документ не закрывается, пока пользователь не ответит. Этот API поддерживается только в Excel.

Методы

getStartupBehavior()

Возвращает текущее поведение при запуске надстройки.
hide()

Скрывает область задач.
onVisibilityModeChanged(handler)

Добавляет обработчик для onVisibilityModeChanged события.
setStartupBehavior(behavior)

Задает поведение при запуске надстройки при открытии документа в следующий раз.
showAsTaskpane()

Показывает область задач, связанную с надстройкой.

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

beforeDocumentCloseNotification

Представляет модальное диалоговое окно уведомлений, которое может отображаться при попытке пользователя закрыть документ. Документ не закрывается, пока пользователь не ответит. Этот API поддерживается только в Excel.

beforeDocumentCloseNotification: BeforeDocumentCloseNotification;

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

Office.BeforeDocumentCloseNotification

Комментарии

Набор обязательных требований: SharedRuntime 1.2

Сведения о методе

getStartupBehavior()

Возвращает текущее поведение при запуске надстройки.

getStartupBehavior(): Promise<Office.StartupBehavior>;

Возвращаемое значение

Promise<Office.StartupBehavior>

Комментарии

Набор обязательных элементов: SharedRuntime 1.1

hide()

Скрывает область задач.

hide(): Promise<void>;

Возвращаемое значение

Promise<void>

Обещание, которое разрешается при скрытии пользовательского интерфейса.

Комментарии

Набор обязательных элементов: SharedRuntime 1.1

onVisibilityModeChanged(handler)

Добавляет обработчик для onVisibilityModeChanged события.

onVisibilityModeChanged(
            handler: (message: VisibilityModeChangedMessage) => void,
        ): Promise<() => Promise<void>>;

Параметры

handler

(message: Office.VisibilityModeChangedMessage) => void

Функция обработчика, вызываемая при создании события. Эта функция принимает сообщение для принимающего компонента.

Возвращаемое значение

Promise<() => Promise<void>>

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

Комментарии

Набор обязательных элементов: SharedRuntime 1.1

Примеры

Office.onReady(() => {
    Office.addin.onVisibilityModeChanged((args) => {
        if (args.visibilityMode === Office.VisibilityMode.taskpane) {
            // Do something when the task pane is visible.
        }
    });

    // Other startup tasks.
});

setStartupBehavior(behavior)

Задает поведение при запуске надстройки при открытии документа в следующий раз.

setStartupBehavior(behavior: Office.StartupBehavior): Promise<void>;

Параметры

behavior
Office.StartupBehavior

Указывает поведение при запуске надстройки.

Возвращаемое значение

Promise<void>

Комментарии

Набор обязательных элементов: SharedRuntime 1.1

Примеры

// Configure your add-in to load and start running when the document is opened.
Office.addin.setStartupBehavior(Office.StartupBehavior.load);

showAsTaskpane()

Показывает область задач, связанную с надстройкой.

showAsTaskpane(): Promise<void>;

Возвращаемое значение

Promise<void>

Обещание, которое разрешается при отображении пользовательского интерфейса.

Комментарии

Набор обязательных элементов: SharedRuntime 1.1