Home > SYS_ShortcutKey > register

SYS_ShortcutKey.register() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

注册快捷键

Signature

public register(id: string, props: ISYS_ShortcutKeyDataWithCallFn): boolean;

Parameters

Parameter	Type	Description
id	string	快捷键 ID，将会自动拼接上扩展 UUID 作为前缀
props	ISYS_ShortcutKeyDataWithCallFn	快捷键数据

Returns

boolean

注册是否成功

Remarks

此处注册快捷键时传入的 shortcutKey 仅为默认快捷键，用户可以在设置中修改

如若该快捷键与系统快捷键冲突，系统快捷键将会优先生效

如果需要修改已注册的快捷键信息，可以直接调用本接口，并在 props 中传入完整的需要修改的快捷键数据

本接口无法修改系统快捷键

注意：本接口仅扩展有效，在独立脚本环境内调用将始终 throw Error ADD since EDA v4.2