Home > SYS_ShortcutKey > registerShortcutKey

SYS_ShortcutKey.registerShortcutKey() method

此 API 当前处于 BETA 预览状态，希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改，请不要将它用于任何正式环境。

注册快捷键

签名

registerShortcutKey(shortcutKey: TShortcutKeys, title: string, callbackFn: (shortcutKey: TShortcutKeys) => void | Promise<void>, documentType: Array<ESYS_ShortcutKeyEffectiveEditorDocumentType> | undefined, scene: Array<ESYS_ShortcutKeyEffectiveEditorScene> | undefined, hotkeyCmd: string): Promise<boolean>;

参数名

参数	类型	描述
shortcutKey	TShortcutKeys	快捷键，数组中包含多个元素则解析为组合快捷键，将按规则排序后存入缓存
title	string	快捷键标题，快捷键的友好名称
callbackFn	(shortcutKey: TShortcutKeys) => void | Promise<void>	回调函数
documentType	Array<ESYS_ShortcutKeyEffectiveEditorDocumentType> | undefined
scene	Array<ESYS_ShortcutKeyEffectiveEditorScene> | undefined
hotkeyCmd	string

返回值

Promise<boolean>

注册操作是否成功