在 WinForms 專案中使用全域性快捷鍵
藉助於全域性快捷鍵,使用者可以在任何地方操控程式,觸發對應的功能。但 WinForms 框架並沒有提供全域性快捷鍵的功能。想要實現全域性快捷鍵需要跟 Windows API 打交道。本文就交你如何使用 Windows API 使用全域性快捷鍵。
瞭解訊息迴圈機制
訊息機制簡要介紹
一個窗體到底是如何工作的呢?它是如何響應使用者的操作的呢?不妨先讓我們搞明白一個程式的執行機制吧。
在 Windows 上面,一個桌面應用程式是通過訊息機制驅動的。訊息(Message)攜帶著對應窗體發生了什麼的資訊。如,使用者按下了按鍵、滑鼠移動或者點選等等。
那麼工作流程是怎樣的呢?
-
首先,使用者做出了一些操作或者一些其他的事情發生了,系統就會建立一條訊息出來。接著,把訊息投送到當前對應的窗體的執行緒訊息佇列。等待應用程式處理訊息。訊息會攜帶一個窗體的控制代碼、一個訊息號、以及一些額外資訊。這些資訊可以告訴應用程式,到底發生了什麼事情。
-
應用程式完成初始化之後,就開始建立訊息處理機制。通過不斷迴圈從訊息佇列獲取訊息。對於那些有對應目標窗體的訊息,將訊息轉發到對應窗體的窗體處理函式。
-
窗體處理函式負責處理訊息。
在 Win Forms 中,訊息的派發機制
在 Win Forms 中, Application.Run 方法就實現了訊息處理機制。我們看一下 Program.cs 中的以下程式碼。這段程式碼就是建立一個窗體,接著,把窗體傳入 Application.Run 方法。而 Application.Run 方法,首先顯示這個窗體,接著就開始迴圈從訊息佇列獲取訊息並派發訊息了。
[STAThread] static void Main() { Application.EnableVisualStyles(); Application.SetCompatibleTextRenderingDefault(false); Application.Run(new Form1()); }
Application.Run 方法的描述如下:
在當前執行緒上開始執行標準應用程式訊息迴圈,並使指定窗體可見。
那麼,能不能直觀的看到有哪些訊息放到了咱們的訊息佇列裡面呢?通過檢視 Application 類的文件,我們找到了如下方法:
public static void AddMessageFilter (System.Windows.Forms.IMessageFilter value);
新增訊息篩選器以便在向目標傳送 Windows 訊息時監視這些訊息。
很顯然,想要檢視到訊息需要我們實現一個 IMessageFilter 介面的類。我們來編寫一個這樣的類:如下:
internal class MyMessageFilter : IMessageFilter
{
public bool PreFilterMessage(ref Message m)
{
Console.WriteLine("MyMessageFilter: {0}", m.ToString());
return false;
}
}
程式碼非常的易懂。不過值得說到的是,返回 false 的含義是允許這條訊息繼續向下傳遞,如果返回 true,則該條訊息就不會往下繼續傳遞。
下面,我們把這個訊息處理器註冊到 Application 中去。
Main 方法下編寫如下的程式碼:
Application.AddMessageFilter(new MyMessageFilter()); ;
Application.Run(new Form1());
第一行就是我們新增加的程式碼。接著為了能出現控制檯視窗,我們應該把程式的目標平臺選為 Windows 控制檯程式。最後開始執行應用程式。應該就可以在控制檯中看到有資訊輸出了。
窗體的訊息處理函式探祕
通過 Application 建立的訊息派發機制,訊息會被髮送到下一站,也就是窗體的訊息處理函式。在 Win Forms 中,我們可以通過重寫訊息的處理函式,來窺探這些訊息內容。請看如下程式碼:
internal class Form1 : Form
{
protected override void WndProc(ref Message m)
{
Console.WriteLine("Form1 WndProc: {0}", m.ToString());
base.WndProc(ref m);
}
}
訊息機制小結
通過以上程式碼,你應該對訊息機制有了一個直觀的描述。那麼,下面會說到我們的今天的主角——熱鍵。由於熱鍵被觸發的時候,也是通過訊息機制告知應用程式的,因此我們當然要會處理熱鍵訊息啦。相信你現在已經可以寫出對應的程式碼了。
匯入相關 API
註冊全域性熱鍵和撤銷全域性熱鍵的 API 文件如下,共你去查閱。
RegisterHotKey
https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-registerhotkey
UnregisterHotKey
https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-unregisterhotkey
為了能把這兩個函式引入我們的程式,我們需要定義一個列舉類。如下:
/// <summary>
/// 為熱鍵提供修飾鍵選項的列舉。
/// </summary>
[Flags]
public enum KeyModifiers
{
/// <summary>
/// 沒有修飾鍵。
/// </summary>
None = 0X00,
/// <summary>
/// ALT 鍵。
/// </summary>
Alt = 0X01,
/// <summary>
/// CTRL 鍵。
/// </summary>
Control = 0X02,
/// <summary>
/// SHIFT 鍵。
/// </summary>
Shift = 0X04,
/// <summary>
/// Windows 徽標鍵。
/// </summary>
Windows = 0X08,
/// <summary>
/// 熱鍵按下時禁止重複發出訊息。
/// </summary>
NoRepeat = 0X4000
}
接著我們引入兩個API 函式和一個常量。如下:
/// <summary>
/// 匯入和定義 Windows SDK 中關於全域性熱鍵函式及常量的靜態類。
/// </summary>
internal static class NativeMethods
{
/// <summary>
/// 定義使用 <see cref="RegisterHotKey(IntPtr, int, KeyModifiers, VirtualKeys)"/> 註冊的熱鍵觸發的訊息的訊息號。
/// </summary>
public const int WM_HOTKEY = 0X0312;
/// <summary>
/// 註冊系統全域性熱鍵。
/// </summary>
/// <param name="hWnd">關聯的視窗控制代碼。如果此值為零,則與當前縣城關聯, WM_HOTKEY 訊息會放到當前縣城的訊息佇列。</param>
/// <param name="id">用來標識熱鍵的識別符號。</param>
/// <param name="fsModifiers">修飾鍵和選項的值。</param>
/// <param name="vk">虛擬鍵程式碼。</param>
/// <returns>成功返回 true, 失敗返回 false。如需錯誤資訊可呼叫 <see cref="Marshal.GetLastWin32Error"/> 方法。</returns>
/// <seealso cref="UnregisterHotKey(IntPtr, int)"/>
/// <remarks>
/// 當鍵被按下時,系統會尋找匹配的已註冊的全域性熱鍵,如果該全域性熱鍵與一個窗體關聯,則 <see cref="WM_HOTKEY"/> 訊息會放到該窗體的訊息佇列,若未與一個窗體關聯,則將 <see cref="WM_HOTKEY"/> 訊息傳送到對應的執行緒訊息佇列。
/// 該函式無法將全域性熱鍵與另一個執行緒建立的窗體關聯。
/// 如果將要註冊的全域性熱鍵已被註冊,呼叫該函式將失敗。
/// 如果已註冊的全域性熱鍵具有與將要註冊的全域性熱鍵相同的窗體控制代碼 (hWnd) 和識別符號 (id), 則新註冊的全域性熱鍵與舊全域性熱鍵一起維護。 如果就全域性熱鍵需要被新全域性熱鍵替換,應該先顯示地呼叫 <see cref="UnregisterHotKey(IntPtr, int)"/> 函式以撤銷註冊的全域性熱鍵, 接著呼叫該函式註冊新的全域性熱鍵。
/// 在 Windows Server 2003 上: 新全域性熱鍵與以註冊的全域性熱鍵具有相同的窗體控制代碼 (hWnd) 和識別符號 (id) 時, 舊全域性熱鍵將被新的全域性熱鍵替換。
/// F12 應當保留給偵錯程式使用。
/// 應用程式必須指定 0x0000 到 0xBFFF之間的值, 共享類庫必須指定 0xC000 到 0xFFFF 之間的值給 id 引數。
/// </remarks>
[DllImport("user32.dll", CharSet = CharSet.Auto, SetLastError = true)]
public static extern bool RegisterHotKey(IntPtr hWnd, int id, KeyModifiers fsModifiers, Keys vk);
/// <summary>
/// 撤銷已經註冊的系統全域性熱鍵。
/// </summary>
/// <param name="hWnd">關聯的視窗控制代碼。如果沒有與任何視窗關聯,則必須為零。</param>
/// <param name="id">需要撤銷的熱鍵的識別符號。</param>
/// <returns>成功返回 true, 失敗返回 false。如需錯誤資訊可呼叫 <see cref="Marshal.GetLastWin32Error"/>方法。</returns>
/// <seealso cref="RegisterHotKey(IntPtr, int, KeyModifiers, VirtualKeys)"/>
[DllImport("user32.dll", CharSet = CharSet.Auto, SetLastError = true)]
public static extern bool UnregisterHotKey(IntPtr hWnd, int id);
}
以上,我們就準備好了相關的型別和平臺呼叫的定義程式碼。
使用熱鍵的流程
使用熱鍵的流程如下:
-
在必要的時候註冊需要的熱鍵。
-
在必要的時候釋放註冊的熱鍵。
-
處理好熱鍵訊息。
關聯到窗體的熱鍵例項
註冊熱鍵
下面我們通過註冊一個 Ctrl + Shift + H 這一熱鍵,演示關聯到窗體的熱鍵的工作流程。首先,區分不同熱鍵的方法是指定不同的 id 識別符號。我們首先定義一個常量,規定我們這個熱鍵的識別符號:
/// <summary>
/// 定義用於改變窗體顯示狀態熱鍵的識別符號。
/// </summary>
const int ChangeVisibleHotKeyId = 1;
接著我們在窗體的 Load 事件下編寫如下程式碼,註冊我們需要的熱鍵。
private void Form1_Load(object sender, EventArgs e)
{
NativeMethods.RegisterHotKey(this.Handle, ChangeVisibleHotKeyId, KeyModifiers.Control | KeyModifiers.Shift, Keys.H);
}
處理熱鍵
為了使該熱鍵能實現對應的功能。我們應該重寫窗體的處理函式,並且,把 WM_HOTKEY 訊息拿出來,並且派遣到另外一個方法實現具體的功能。程式碼如下:
protected override void WndProc(ref Message m)
{
Console.WriteLine("Form1 WndProc: {0}", m.ToString());
// 根據訊息 id 處理訊息。
switch (m.Msg)
{
case NativeMethods.WM_HOTKEY:
// 我們把熱鍵的 id 取出來,呼叫處理熱鍵的方法。
this.ProcessHotKeyMessage(m.WParam.ToInt32());
break;
default:
base.WndProc(ref m);
break;
}
}
/// <summary>
/// 處理熱鍵訊息。我們在這裡實現熱鍵對應的功能。
/// </summary>
/// <param name="hotKeyId">熱鍵的識別符號。</param>
private void ProcessHotKeyMessage(int hotKeyId)
{
// 根據不同的id 區分不同的熱鍵。
switch (hotKeyId)
{
case ChangeVisibleHotKeyId:
this.Visible = !this.Visible;
break;
}
}
撤銷熱鍵
最後,我們在窗體銷燬時撤銷我們註冊的熱鍵,程式碼如下:
private void Form1_FormClosed(object sender, FormClosedEventArgs e)
{
NativeMethods.UnregisterHotKey(this.Handle, ChangeVisibleHotKeyId);
}
以上,就完成了我們的熱鍵註冊工作了。可以執行程式試一下是否能正常工作。
更進一步
本文只是展示了關聯到窗體的熱鍵的處理流程。還有一種情況是這樣的,我們的程式並不需要窗體,那麼顯然就不需要創建出來一個窗體。那麼應該如何處理這個熱鍵呢?沒錯,你可以在 MessageFilter 中對熱鍵訊息進行處理。
完整程式碼
以下是本程式的完整程式碼:
using System;
using System.Runtime.InteropServices;
using System.Windows.Forms;
namespace HotKeyApp
{
internal class Program
{
[STAThread]
static void Main()
{
Application.EnableVisualStyles();
Application.SetCompatibleTextRenderingDefault(false);
Application.AddMessageFilter(new MyMessageFilter()); ;
Application.Run(new Form1());
}
}
internal class Form1 : Form
{
/// <summary>
/// 定義用於改變窗體顯示狀態熱鍵的識別符號。
/// </summary>
const int ChangeVisibleHotKeyId = 1;
public Form1()
{
this.Load += Form1_Load;
this.FormClosed += Form1_FormClosed;
}
private void Form1_FormClosed(object sender, FormClosedEventArgs e)
{
NativeMethods.UnregisterHotKey(this.Handle, ChangeVisibleHotKeyId);
}
private void Form1_Load(object sender, EventArgs e)
{
NativeMethods.RegisterHotKey(this.Handle, ChangeVisibleHotKeyId, KeyModifiers.Control | KeyModifiers.Shift, Keys.H);
}
protected override void WndProc(ref Message m)
{
Console.WriteLine("Form1 WndProc: {0}", m.ToString());
// 根據訊息 id 處理訊息。
switch (m.Msg)
{
case NativeMethods.WM_HOTKEY:
// 我們把熱鍵的 id 取出來,呼叫處理熱鍵的方法。
this.ProcessHotKeyMessage(m.WParam.ToInt32());
break;
default:
base.WndProc(ref m);
break;
}
}
/// <summary>
/// 處理熱鍵訊息。我們在這裡實現熱鍵對應的功能。
/// </summary>
/// <param name="hotKeyId">熱鍵的識別符號。</param>
private void ProcessHotKeyMessage(int hotKeyId)
{
// 根據不同的id 區分不同的熱鍵。
switch (hotKeyId)
{
case ChangeVisibleHotKeyId:
this.Visible = !this.Visible;
break;
}
}
}
internal class MyMessageFilter : IMessageFilter
{
public bool PreFilterMessage(ref Message m)
{
Console.WriteLine("MyMessageFilter: {0}", m.ToString());
return false;
}
}
/// <summary>
/// 為熱鍵提供修飾鍵選項的列舉。
/// </summary>
[Flags]
public enum KeyModifiers
{
/// <summary>
/// 沒有修飾鍵。
/// </summary>
None = 0X00,
/// <summary>
/// ALT 鍵。
/// </summary>
Alt = 0X01,
/// <summary>
/// CTRL 鍵。
/// </summary>
Control = 0X02,
/// <summary>
/// SHIFT 鍵。
/// </summary>
Shift = 0X04,
/// <summary>
/// Windows 徽標鍵。
/// </summary>
Windows = 0X08,
/// <summary>
/// 熱鍵按下時禁止重複發出訊息。
/// </summary>
NoRepeat = 0X4000
}
/// <summary>
/// 匯入和定義 Windows SDK 中關於全域性熱鍵函式及常量的靜態類。
/// </summary>
internal static class NativeMethods
{
/// <summary>
/// 定義使用 <see cref="RegisterHotKey(IntPtr, int, KeyModifiers, VirtualKeys)"/> 註冊的熱鍵觸發的訊息的訊息號。
/// </summary>
public const int WM_HOTKEY = 0X0312;
/// <summary>
/// 註冊系統全域性熱鍵。
/// </summary>
/// <param name="hWnd">關聯的視窗控制代碼。如果此值為零,則與當前縣城關聯, WM_HOTKEY 訊息會放到當前縣城的訊息佇列。</param>
/// <param name="id">用來標識熱鍵的識別符號。</param>
/// <param name="fsModifiers">修飾鍵和選項的值。</param>
/// <param name="vk">虛擬鍵程式碼。</param>
/// <returns>成功返回 true, 失敗返回 false。如需錯誤資訊可呼叫 <see cref="Marshal.GetLastWin32Error"/> 方法。</returns>
/// <seealso cref="UnregisterHotKey(IntPtr, int)"/>
/// <remarks>
/// 當鍵被按下時,系統會尋找匹配的已註冊的全域性熱鍵,如果該全域性熱鍵與一個窗體關聯,則 <see cref="WM_HOTKEY"/> 訊息會放到該窗體的訊息佇列,若未與一個窗體關聯,則將 <see cref="WM_HOTKEY"/> 訊息傳送到對應的執行緒訊息佇列。
/// 該函式無法將全域性熱鍵與另一個執行緒建立的窗體關聯。
/// 如果將要註冊的全域性熱鍵已被註冊,呼叫該函式將失敗。
/// 如果已註冊的全域性熱鍵具有與將要註冊的全域性熱鍵相同的窗體控制代碼 (hWnd) 和識別符號 (id), 則新註冊的全域性熱鍵與舊全域性熱鍵一起維護。 如果就全域性熱鍵需要被新全域性熱鍵替換,應該先顯示地呼叫 <see cref="UnregisterHotKey(IntPtr, int)"/> 函式以撤銷註冊的全域性熱鍵, 接著呼叫該函式註冊新的全域性熱鍵。
/// 在 Windows Server 2003 上: 新全域性熱鍵與以註冊的全域性熱鍵具有相同的窗體控制代碼 (hWnd) 和識別符號 (id) 時, 舊全域性熱鍵將被新的全域性熱鍵替換。
/// F12 應當保留給偵錯程式使用。
/// 應用程式必須指定 0x0000 到 0xBFFF之間的值, 共享類庫必須指定 0xC000 到 0xFFFF 之間的值給 id 引數。
/// </remarks>
[DllImport("user32.dll", CharSet = CharSet.Auto, SetLastError = true)]
public static extern bool RegisterHotKey(IntPtr hWnd, int id, KeyModifiers fsModifiers, Keys vk);
/// <summary>
/// 撤銷已經註冊的系統全域性熱鍵。
/// </summary>
/// <param name="hWnd">關聯的視窗控制代碼。如果沒有與任何視窗關聯,則必須為零。</param>
/// <param name="id">需要撤銷的熱鍵的識別符號。</param>
/// <returns>成功返回 true, 失敗返回 false。如需錯誤資訊可呼叫 <see cref="Marshal.GetLastWin32Error"/>方法。</returns>
/// <seealso cref="RegisterHotKey(IntPtr, int, KeyModifiers, VirtualKeys)"/>
[DllImport("user32.dll", CharSet = CharSet.Auto, SetLastError = true)]
public static extern bool UnregisterHotKey(IntPtr hWnd, int id);
}
}
最後
最後,希望本文對於你有些許幫助。
參考資料
視窗訊息 (入門與 Win32 和 c + + 一起) - Win32 apps | Microsoft Docs
https://docs.microsoft.com/zh-cn/windows/win32/learnwin32/window-messages
RegisterHotKey function (winuser.h) - Win32 apps | Microsoft Docs
https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-registerhotkey
UnregisterHotKey function (winuser.h) - Win32 apps | Microsoft Docs
https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-unregisterhotkey
WM_HOTKEY 訊息 (Winuser.h) - Win32 apps | Microsoft Docs
https://docs.microsoft.com/zh-cn/windows/win32/inputdev/wm-hotkey
Application 類 (System.Windows.Forms) | Microsoft Docs
https://docs.microsoft.com/zh-cn/dotnet/api/system.windows.forms.application?view=netframework-4.8