Office.Actions interface

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

Управляет действиями и сочетаниями клавиш.

Свойства

associate

Связывает идентификатор или имя действия с функцией.

Методы

areShortcutsInUse(shortcuts)

Проверяет, используется ли в настоящее время для пользователя набор сочетаний сочетаний, как определено другой надстройкой или приложением Office.
getShortcuts()

Возвращает существующие сочетания клавиш для надстройки. Набор всегда включает (1) сочетания клавиш, определенные в расширенном манифесте надстройки для сочетаний клавиш, и (2) пользовательские сочетания клавиш текущего пользователя, если они существуют. Ярлык может быть null , если он конфликтует с ярлыком другой надстройки или с приложением Office. В частности, при null появлении запроса на выбор ярлыка для использования пользователь не выбрал действие текущей надстройки. Дополнительные сведения о конфликтах с ярлыками см. в статье Предотвращение сочетаний клавиш, используемых другими надстройками.
replaceShortcuts(shortcuts)

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

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

associate

Связывает идентификатор или имя действия с функцией.

associate: (actionId: string, actionFunction: (arg?: any) => void) => void;

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

(actionId: string, actionFunction: (arg?: any) => void) => void

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

areShortcutsInUse(shortcuts)

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

areShortcutsInUse(shortcuts: string[]): Promise<Array<{shortcut: string, inUse: boolean}>>;

Параметры

shortcuts

string[]

Массив сочетаний сочетаний клавиш. Например, ["Ctrl+1", "Ctrl+2"].

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

Promise<Array<{shortcut: string, inUse: boolean}>>

Обещание, которое разрешается в массив объектов. Каждый объект состоит из сочетания сочетаний клавиш и логического значения. Значение равно , true если сочетание сочетаний клавиш конфликтует с ярлыком другой надстройки или ярлыком приложения Office; в противном случае — falseзначение . Например, [{shortcut:"Ctrl+1", inUse:true},{shortcut:"Ctrl+2", inUse:false}].

Комментарии

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

getShortcuts()

Возвращает существующие сочетания клавиш для надстройки. Набор всегда включает (1) сочетания клавиш, определенные в расширенном манифесте надстройки для сочетаний клавиш, и (2) пользовательские сочетания клавиш текущего пользователя, если они существуют. Ярлык может быть null , если он конфликтует с ярлыком другой надстройки или с приложением Office. В частности, при null появлении запроса на выбор ярлыка для использования пользователь не выбрал действие текущей надстройки. Дополнительные сведения о конфликтах с ярлыками см. в статье Предотвращение сочетаний клавиш, используемых другими надстройками.

getShortcuts(): Promise<{[actionId: string]: string|null}>;

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

Promise<{[actionId: string]: string|null}>

Обещание, которое разрешается в объект сочетаний клавиш, где ключи — это идентификаторы действий (как определено в расширенном манифесте), а значения — сочетания сочетаний сочетаний. Например, {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}.

Комментарии

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

replaceShortcuts(shortcuts)

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

replaceShortcuts(shortcuts: {[actionId: string]: string}): Promise<void>;

Параметры

shortcuts

{[actionId: string]: string}

Объект настраиваемых сочетаний клавиш с ключами, которые служат идентификаторами действий (как определено в расширенном манифесте), а значениями — сочетаниями сочетаний сочетаний клавиш. Например, {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}. Сведения о том, как указать допустимый идентификатор действия и сочетание клавиш, см. в статье Добавление настраиваемых сочетаний клавиш в надстройки Office. (Обратите внимание, что сочетание клавиш может иметь nullзначение , в этом случае действие сохраняет сочетание ключей, указанное в JSON-файле.)

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

Promise<void>

Обещание, которое разрешается при регистрации каждого настраиваемого назначения ярлыка в shortcuts . Даже если существует конфликт с существующими сочетаниями клавиш, настраиваемое сочетание клавиш будет зарегистрировано. В противном случае обещание будет отклонено с кодом ошибки и сообщением об ошибке. Если идентификатор действия в shortcuts не существует, возвращается код ошибки InvalidOperation или если сочетание сочетаний клавиш недопустимо.

Комментарии

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