FastHotKeyForWPF 4.0.0

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Framework 4.6.2 This package targets .NET Framework 4.6.2. The package is compatible with this framework or higher. 
dotnet add package FastHotKeyForWPF --version 4.0.0
                    


                    

                
NuGet\Install-Package FastHotKeyForWPF -Version 4.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="FastHotKeyForWPF" Version="4.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="FastHotKeyForWPF" Version="4.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="FastHotKeyForWPF" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add FastHotKeyForWPF --version 4.0.0
                    


                    

                
#r "nuget: FastHotKeyForWPF, 4.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=FastHotKeyForWPF&version=4.0.0
                    


                            Install FastHotKeyForWPF as a Cake Addin
                        

                    

                
#tool nuget:?package=FastHotKeyForWPF&version=4.0.0
                    


                            Install FastHotKeyForWPF as a Cake Tool

FastHotKeyForWPF 🚀

中文 | English

<a name="中文"></a>

中文版

简介 📖

用优雅的方式构建WPF热键功能，支持全局/本地热键注册、可视化控件、源码生成器等特性

GitHub NuGet

版本矩阵 📦

版本 类型 目标框架 特性
2.4.0 LTS .NET 6 非源码生成器
3.0.0 LTS .NET 5 / .NET Framework 4.7.1 基础功能
4.0.0 LTS .NET 5 / .NET Framework 4.6.2 统一API

最新特性 ✨

  1. 统一API - 跨框架一致的操作体验
  2. 增强注销 - 返回成功注销的热键数量
  3. 源码生成器 - 支持.NET Framework（需手动配置）
  4. 文档升级 - 新增函数原型速查表

快速开始 🚀

Ⅰ 代码注册热键
// 全局热键（任意窗口生效）
GlobalHotKey.Register(
    VirtualModifiers.Ctrl | VirtualModifiers.Alt,
    VirtualKeys.F1,
    (sender, e) => MessageBox.Show("全局热键触发！")
);

// 本地热键（指定控件生效）
LocalHotKey.Register(
    textBox1, 
    new[] { Key.LeftCtrl, Key.K, Key.D },
    (sender, e) => textBox1.Text = "Ctrl+K+D 已触发"
);
Ⅱ 可视化热键控件
  1. 创建自定义控件（自动生成热键逻辑）
[HotKeyComponent]
public partial class HotKeyBox : UserControl
{
    // 控件交互逻辑...
}
  1. XAML绑定热键属性
<TextBox KeyDown="OnHotKeyReceived"
         Text="{Binding HotkeyText, RelativeSource={RelativeSource AncestorType=local:HotKeyBox}}"/>

核心API 🔧

GlobalHotKey
方法 说明
Awake() 初始化热键系统
Register(modifiers, keys) 注册全局热键
Unregister(modifiers, keys) 注销全局热键
Dispose() 释放所有热键资源
LocalHotKey
方法 说明
Register(target, keys) 注册控件级热键
Unregister(target) 注销控件所有热键
RegisterMainWindow(keys) 注册主窗口级热键
UnregisterMainWindow() 注销主窗口所有热键

完整文档 📚

查看完整函数原型与使用指南

<a name="english"></a>

English Version

Introduction 📖

Elegant hotkey implementation for WPF, featuring global/local registration, visual controls, and source generators.

GitHub NuGet

Version Matrix 📦

Version Type Target Frameworks Features
2.4.0 LTS .NET 6 Non-SourceGen
3.0.0 LTS .NET 5 / .NET Framework 4.7.1 Basic Features
4.0.0 LTS .NET 5 / .NET Framework 4.6.2 Unified API

Highlights ✨

  1. Unified API - Consistent cross-framework experience
  2. Enhanced Unregister - Returns success count
  3. Source Generator - .NET Framework support (manual config)
  4. Documentation - Added function prototypes quick reference

Quick Start 🚀

Ⅰ Code Registration
// Global hotkey (works system-wide)
GlobalHotKey.Register(
    VirtualModifiers.Ctrl | VirtualModifiers.Alt,
    VirtualKeys.F1,
    (sender, e) => MessageBox.Show("Global Hotkey Triggered!")
);

// Local hotkey (control-specific)
LocalHotKey.Register(
    textBox1,
    new[] { Key.LeftCtrl, Key.K, Key.D },
    (sender, e) => textBox1.Text = "Ctrl+K+D Activated"
);
Ⅱ Visual Control
  1. Create custom control (auto-generated logic)
[HotKeyComponent]
public partial class HotKeyBox : UserControl
{
    // Control interactions...
}
  1. XAML Data Binding
<TextBox KeyDown="OnHotKeyReceived"
         Text="{Binding HotkeyText, RelativeSource={RelativeSource AncestorType=local:HotKeyBox}}"/>

Core API 🔧

GlobalHotKey
Method Description
Awake() Initialize hotkey system
Register(modifiers, keys) Register global hotkey
Unregister(modifiers, keys) Unregister global hotkey
Dispose() Release all hotkey resources
LocalHotKey
Method Description
Register(target, keys) Register control-level hotkey
Unregister(target) Unregister all control hotkeys
RegisterMainWindow(keys) Register mainwindow-level hotkeys
UnregisterMainWindow() Clear main window hotkeys

Full Documentation 📚

View Complete API Reference

Product Compatible and additional computed target framework versions.
.NET net5.0-windows7.0 is compatible.  net6.0-windows was computed.  net7.0-windows was computed.  net8.0-windows was computed.  net9.0-windows was computed. 
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.0 59 3/22/2025
3.0.0 112 2/16/2025
2.4.0 140 1/21/2025
2.2.0 203 8/8/2024 2.2.0 is deprecated.