FastHotKeyForWPF 2.1.0

FastHotKeyForWPF

Quickly build global hotkeys in WPF programs

Supported [ .NET6.0 ] [ .NET8.0 ]

• github
• nuget
• gitee

更新

Bilibili

<details> <summary>Version 2.1.0 已上线</summary>

新增

• 对 [ SHIFT ] 的支持
• 对 [ 多个ModelKey ] 的支持
• 对 [ uint转换 ] 的支持

修改

• IAutoHotKeyProperty 中的 CurrentKeyA [ 由 Key 变为 uint ]
• HotKeyViewModelBase 提供 [ 更好的 UpdateHotKey() 与 UpdateText() ]

</details>

Ⅰ 引入命名空间

C#

using FastHotKeyForWPF;

XAML

xmlns:hk="clr-namespace:FastHotKeyForWPF;assembly=FastHotKeyForWPF"

Ⅱ 激活与销毁

示例. GlobalHotKey

        protected override void OnSourceInitialized(EventArgs e)
        {
            base.OnSourceInitialized(e);

            GlobalHotKey.Awake();
        }

        protected override void OnClosed(EventArgs e)
        {
            GlobalHotKey.Destroy();

            base.OnClosed(e);
        }

重写MainWindow的OnSourceInitialized与OnClosed是推荐的做法，当然，你可以选择其它时刻激活，只要你能确保Awake()时窗口句柄已存在

Ⅲ 使用 GlobalHotKey ，注册热键

情景. 假设你定义了以下HandlerA , 并希望用户触发热键时执行它

        private void HandlerA(object sender, HotKeyEventArgs e)
        {
            int ID = e.RegisterInfo.RegisterID;

            MessageBox.Show($"A HotKey Has Been Invoked Whose ID is {ID}");
        }

示例1. 注册热键 [ Ctrl + F1 ] ⇒ [ HandlerA ]

        protected override void OnSourceInitialized(EventArgs e)
        {
            base.OnSourceInitialized(e);
            GlobalHotKey.Awake();

            GlobalHotKey.Add(ModelKeys.CTRL, TestA);
        }

示例2. 注册热键 [ Alt + Ctrl + F1 ] ⇒ [ HandlerA ]

        protected override void OnSourceInitialized(EventArgs e)
        {
            base.OnSourceInitialized(e);
            GlobalHotKey.Awake();

            GlobalHotKey.Add(ModelKeys.CTRL | ModelKeys.ALT, TestA);
        }

示例3. 注册热键 [ Alt + Ctrl + Shift + F1 ] ⇒ [ HandlerA ]

        protected override void OnSourceInitialized(EventArgs e)
        {
            base.OnSourceInitialized(e);
            GlobalHotKey.Awake();

            GlobalHotKey.Add(ModelKeys.CTRL | ModelKeys.ALT | ModelKeys.SHIFT, NormalKeys.F1, TestA);
        }

拓展1. 使用集合表示 ModelKeys , 注册热键 [ Alt + Ctrl + Shift + F1 ] ⇒ [ HandlerA ]

        protected override void OnSourceInitialized(EventArgs e)
        {
            base.OnSourceInitialized(e);
            GlobalHotKey.Awake();

            List<ModelKeys> list = new List<ModelKeys>()
            {
                ModelKeys.CTRL,
                ModelKeys.ALT,
                ModelKeys.SHIFT
            };
            GlobalHotKey.Add(list, NormalKeys.F1, TestA);
        }

拓展2. 使用uint表示 ModelKeys , 注册热键 [ Alt + Ctrl + Shift + F1 ] ⇒ [ HandlerA ]

        protected override void OnSourceInitialized(EventArgs e)
        {
            base.OnSourceInitialized(e);
            GlobalHotKey.Awake();

            uint target = (uint)(ModelKeys.CTRL | ModelKeys.ALT | ModelKeys.SHIFT);
            GlobalHotKey.Add(target, NormalKeys.F1, TestA);
        }

注意

• 若使用 ICollection 表示多个 ModelKeys , 该集合的元素个数应该 >0
• GlobalHotKey 对 uint ICollection 实现了重载 , 接下来只以使用 ModelKeys 为例
• RegisterInfoCollection 对 uint ICollection 实现了重载 , 接下来只以使用 ModelKeys 为例

恭喜，你已经掌握了该库最核心的功能！

Ⅳ 使用 GlobalHotKey ，修改热键

示例1. 已知触发Keys ,修改其对应的处理函数HotKeyEventHandler

        protected override void OnSourceInitialized(EventArgs e)
        {
            base.OnSourceInitialized(e);

            GlobalHotKey.Awake();
            GlobalHotKey.Add(ModelKeys.CTRL, NormalKeys.F1, HandlerA);
            //初始热键为 [ CTRL + F1 => HandlerA ]

            GlobalHotKey.EditHandler(ModelKeys.CTRL,NormalKeys.F1, HandlerB);
            //由 [ CTRL + F1 => HandlerA ] 变为 [ CTRL + F1 => HandlerB ];
        }

示例2. 已知处理函数HotKeyEventHandler ，修改其对应的触发Keys

        protected override void OnSourceInitialized(EventArgs e)
        {
            base.OnSourceInitialized(e);

            GlobalHotKey.Awake();
            GlobalHotKey.Add(ModelKeys.CTRL, NormalKeys.F1, HandlerA);
            //初始热键为 [ CTRL + F1 => HandlerA ]

            GlobalHotKey.EditKeys(HandlerA, ModelKeys.CTRL, NormalKeys.Q);
            //由 [ CTRL + F1 => HandlerA ] 变为 [ CTRL + Q => HandlerA ];
            //注意:通常情况下,即便允许多个组合键指向同一Handler,也不建议您这么做,类库默认只修改第一个找到的Handler,意外的情况需要您手动查询并修改热键
        }

Ⅴ 使用 GlobalHotKey ，删除热键

示例1. 删除所有

        protected override void OnSourceInitialized(EventArgs e)
        {
            base.OnSourceInitialized(e);

            GlobalHotKey.Awake();
            int ID = GlobalHotKey.Add(ModelKeys.CTRL, NormalKeys.F1, HandlerA);
            //初始热键为 [ CTRL + F1 => HandlerA ]
            //注册成功将返回注册ID，否则返回-1

            GlobalHotKey.Clear();
            //删除所有热键
        }

示例2. 条件删除

        protected override void OnSourceInitialized(EventArgs e)
        {
            base.OnSourceInitialized(e);

            GlobalHotKey.Awake();
            int ID = GlobalHotKey.Add(ModelKeys.CTRL, NormalKeys.F1, HandlerA);
            //初始热键为 [ CTRL + F1 => HandlerA ]
            //注册成功将返回注册ID，否则返回-1

            GlobalHotKey.DeleteById(ID);
            GlobalHotKey.DeleteByKeys(ModelKeys.CTRL, NormalKeys.F1);
            GlobalHotKey.DeleteByHandler(HandlerA);
            //删除指定热键(三种方案选一个即可)
            //注意:DeleteByHandler与EditKeys特性不同,它会删除所有注册了指定Handler的热键,而不是只针对第一个
        }

Ⅵ 使用 RegisterCollection ，索引式地查询注册在列的热键信息 （ RegisterInfo 对象 ）

介绍. RegisterInfo 包含的信息

示例1. 根据 ID 查询注册信息

        RegisterInfo Info = GlobalHotKey.Registers[2004];

示例2. 根据 Keys 查询注册信息

        RegisterInfo Info = GlobalHotKey.Registers[ModelKeys.CTRL,NormalKeys.F1];

示例3. 根据 Handler 查询注册信息

        List<RegisterInfo> Infos = GlobalHotKey.Registers[HandlerA];

Ⅶ 使用 KeyHelper 提供的静态工具

Ⅷ 使用库提供的UserControl搭建您的热键设置界面

引入库

xmlns:hk="clr-namespace:FastHotKeyForWPF;assembly=FastHotKeyForWPF"

XAML使用库中控件

• 数字以D开头 , 范围 D0~D9
• ModelKey以 uint 书写

            
            <hk:HotKeyBox x:Name="KeyBoxA"
                          CurrentKeyA="0x0002"
                          CurrentKeyB="D1"
                          Handler="HandlerA"
                          CornerRadius="15"
                          ActualBackground="#1e1e1e"
                          FixedBorderBrush="White"
                          FixedBorderThickness="2"
                          TextColor="White"
                          HoverTextColor="Violet"
                          HoverBorderBrush="Cyan"
                          ConnectText=" + "
                          ErrorText="Failed"/>

        private void HandlerA(object sender, HotKeyEventArgs e)
        {
            int ID = e.RegisterInfo.RegisterID;
            //此处可获取热键的具体信息

            MessageBox.Show($"A HotKey Has Been Invoked Whose ID is {ID}");
        }

Ⅸ 使用库提供的抽象基类或接口,在MVVM下实现属于您自己的UserControl

引导. 接口与抽象类

示例. 一个注册成功会播放动画的UserControl ( 非常用功能，示例会延后在github补全 )