Office.Actions interface
管理操作和键盘快捷方式。
属性
associate | 将操作的 ID 或名称与函数相关联。 |
方法
are |
根据另一个加载项或 Office 应用程序的定义,检查用户当前是否正在使用一组快捷键组合。 |
get |
获取加载项的现有快捷方式。 该集始终包括 (1) 加载项扩展清单中为键盘快捷方式定义的快捷方式, (2) 当前用户的自定义快捷方式(如果存在)。 如果快捷方式与另一个外接程序的快捷方式或 Office 应用程序冲突,则快捷方式可以是 |
replace |
将现有外接程序快捷方式替换为用户的自定义快捷方式。 |
属性详细信息
associate
将操作的 ID 或名称与函数相关联。
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}>>
解析为对象数组的 promise。 每个对象由快捷键组合和布尔值组成。 如果快捷方式组合与另一个外接程序的快捷方式或 Office 应用程序的快捷方式冲突,则值为 true
;否则为 false
。 例如, [{shortcut:"Ctrl+1", inUse:true},{shortcut:"Ctrl+2", inUse:false}]
。
注解
要求集:
getShortcuts()
获取加载项的现有快捷方式。 该集始终包括 (1) 加载项扩展清单中为键盘快捷方式定义的快捷方式, (2) 当前用户的自定义快捷方式(如果存在)。 如果快捷方式与另一个外接程序的快捷方式或 Office 应用程序冲突,则快捷方式可以是 null
。 具体而言,当系统提示用户选择要使用的快捷方式时,用户未选择当前加载项的操作时,将 null
会出现此情况。 有关快捷方式冲突的详细信息,请参阅 避免其他加载项使用的键组合。
getShortcuts(): Promise<{[actionId: string]: string|null}>;
返回
Promise<{[actionId: string]: string|null}>
一个承诺,该承诺解析为快捷方式的对象,其中键是扩展清单中定义的操作 (的 ID,) 和值是快捷方式组合。 例如, {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}
。
注解
要求集:
replaceShortcuts(shortcuts)
将现有外接程序快捷方式替换为用户的自定义快捷方式。
replaceShortcuts(shortcuts: {[actionId: string]: string}): Promise<void>;
参数
- shortcuts
-
{[actionId: string]: string}
自定义快捷方式的对象,其中键是扩展清单中定义的操作的 ID (,) 值是快捷方式组合。 例如, {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}
。 若要了解如何指定有效的操作 ID 和组合键,请参阅 向 Office 外接程序添加自定义键盘快捷方式。 (请注意,组合键可以是 null
,在这种情况下,操作会保留 JSON 文件中指定的组合键。)
返回
Promise<void>
一个承诺,用于在中 shortcuts
注册每个自定义快捷方式分配时解决。 即使与现有快捷方式发生冲突,也会注册自定义快捷方式。 否则,承诺将被拒绝,并显示错误代码和错误消息。 如果 中的任何 shortcuts
操作 ID 不存在,或者快捷方式组合无效,则返回“InvalidOperation”错误代码。
注解
要求集:
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈