歡迎加入BIM行業開發交流1群 群號:711844216（滿），二群群號：1016453207

背景

小伙伴們在做revit二次開發的時候，可能會需要在自己做的插件運行時，去監聽某個按鍵然后做出相應的反應。比如在生成一個很大的模型時，發現不對勁，想停止程序運行，這個時候就可以通過監聽按鍵事件去取消這個正在運行的程序，或者通過監聽按鍵事件去觸發特定事件。

思路

為了實現全局監聽，這里使用了Hook技術，詳見代碼中的KeyboardHook類

由于hook_KeyDown的返回類型是Void， 如果是系統自帶的函數，可以直接在方法里面寫，但是如果需要將這里面的值傳遞給revit中需要的地方，則需要自己在類中定義一個變量去給他設置一個值，然后再將這個值傳遞給revit中來(參見over)。

鍵位設置，本文設置S鍵可以取消正在運行的程序，對應KeyValue為83，更多的鍵位大家可以參考這篇文章C#按鍵對應的KeyValue

代碼

using System; using Autodesk.Revit.UI; using Autodesk.Revit.DB; using Autodesk.Revit.Attributes; using Autodesk.DesignScript.Geometry; using Autodesk.Revit.DB.Architecture; using System.Text; using System.Runtime.InteropServices; using System.Windows.Forms; using System.Reflection;namespace Listen {[Transaction(TransactionMode.Manual)]public class BridgeApp : IExternalCommand{private bool over = false; //由于我們需要將值在revit中使用，因此這兒用了一個over來表示程序是否繼續運行，其使用將在下面的代碼中得到體現private KeyEventHandler myKeyEventHandeler = null;//按鍵鉤子private KeyboardHook k_hook = new KeyboardHook();private void hook_KeyDown(object sender, KeyEventArgs e){// 這個地方認為按下了鍵盤上的S鍵if (e.KeyValue == 83){over = true; //如果在整個程序運行的時候，S鍵位被按到了，默認的over的false值就會變為true}}public void startListen(){myKeyEventHandeler = new KeyEventHandler(hook_KeyDown);k_hook.KeyDownEvent += myKeyEventHandeler;//鉤住鍵按下k_hook.Start();//安裝鍵盤鉤子}public void stopListen(){if (myKeyEventHandeler != null){k_hook.KeyDownEvent -= myKeyEventHandeler;//取消按鍵事件myKeyEventHandeler = null;k_hook.Stop();//關閉鍵盤鉤子}}public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements){startListen(); //開始監聽,因為是對整個程序進行監聽，所以要放在最開始UIDocument uidoc = commandData.Application.ActiveUIDocument;//程序主體部分//這里的if(over)語句通常要放在循環中 不然一次，很難捕捉到按鍵事件if (over) //如果檢測到了按下S鍵位，則over為True, 則執行整個里面的代碼{//小伙伴可以把需要通過監聽執行的代碼放在這兒//...stopListen();//停止監聽return Result.Succeeded;//程序運行監聽里面的內容//return Result.Cancelled; //當前程序停止運行}return Result.Succeeded;}}class KeyboardHook //這部分代碼來自網友{public event KeyEventHandler KeyDownEvent;public event KeyPressEventHandler KeyPressEvent;public event KeyEventHandler KeyUpEvent;public delegate int HookProc(int nCode, Int32 wParam, IntPtr lParam);static int hKeyboardHook = 0; //聲明鍵盤鉤子處理的初始值//值在Microsoft SDK的Winuser.h里查詢public const int WH_KEYBOARD_LL = 13; //線程鍵盤鉤子監聽鼠標消息設為2，全局鍵盤監聽鼠標消息設為13HookProc KeyboardHookProcedure; //聲明KeyboardHookProcedure作為HookProc類型//鍵盤結構[StructLayout(LayoutKind.Sequential)]public class KeyboardHookStruct{public int vkCode; //定一個虛擬鍵碼。該代碼必須有一個價值的范圍1至254public int scanCode; // 指定的硬件掃描碼的關鍵public int flags; // 鍵標志public int time; // 指定的時間戳記的這個訊息public int dwExtraInfo; // 指定額外信息相關的信息}//使用此功能，安裝了一個鉤子[DllImport("user32.dll", CharSet = CharSet.Auto, CallingConvention = CallingConvention.StdCall)]public static extern int SetWindowsHookEx(int idHook, HookProc lpfn, IntPtr hInstance, int threadId);//調用此函數卸載鉤子[DllImport("user32.dll", CharSet = CharSet.Auto, CallingConvention = CallingConvention.StdCall)]public static extern bool UnhookWindowsHookEx(int idHook);//使用此功能，通過信息鉤子繼續下一個鉤子[DllImport("user32.dll", CharSet = CharSet.Auto, CallingConvention = CallingConvention.StdCall)]public static extern int CallNextHookEx(int idHook, int nCode, Int32 wParam, IntPtr lParam);// 取得當前線程編號（線程鉤子需要用到）[DllImport("kernel32.dll")]static extern int GetCurrentThreadId();//使用WINDOWS API函數代替獲取當前實例的函數,防止鉤子失效[DllImport("kernel32.dll")]public static extern IntPtr GetModuleHandle(string name);public void Start(){// 安裝鍵盤鉤子if (hKeyboardHook == 0){KeyboardHookProcedure = new HookProc(KeyboardHookProc);hKeyboardHook = SetWindowsHookEx(WH_KEYBOARD_LL, KeyboardHookProcedure, GetModuleHandle(System.Diagnostics.Process.GetCurrentProcess().MainModule.ModuleName), 0);//hKeyboardHook = SetWindowsHookEx(WH_KEYBOARD_LL, KeyboardHookProcedure, Marshal.GetHINSTANCE(Assembly.GetExecutingAssembly().GetModules()[0]), 0);//************************************//鍵盤線程鉤子SetWindowsHookEx(13, KeyboardHookProcedure, IntPtr.Zero, GetCurrentThreadId());//指定要監聽的線程idGetCurrentThreadId(),//鍵盤全局鉤子,需要引用空間(using System.Reflection;)//SetWindowsHookEx( 13,MouseHookProcedure,Marshal.GetHINSTANCE(Assembly.GetExecutingAssembly().GetModules()[0]),0);////關于SetWindowsHookEx (int idHook, HookProc lpfn, IntPtr hInstance, int threadId)函數將鉤子加入到鉤子鏈表中，說明一下四個參數：//idHook 鉤子類型，即確定鉤子監聽何種消息，上面的代碼中設為2，即監聽鍵盤消息并且是線程鉤子，如果是全局鉤子監聽鍵盤消息應設為13，//線程鉤子監聽鼠標消息設為7，全局鉤子監聽鼠標消息設為14。lpfn 鉤子子程的地址指針。如果dwThreadId參數為0 或是一個由別的進程創建的//線程的標識，lpfn必須指向DLL中的鉤子子程。 除此以外，lpfn可以指向當前進程的一段鉤子子程代碼。鉤子函數的入口地址，當鉤子鉤到任何//消息后便調用這個函數。hInstance應用程序實例的句柄。標識包含lpfn所指的子程的DLL。如果threadId 標識當前進程創建的一個線程，而且子//程代碼位于當前進程，hInstance必須為NULL。可以很簡單的設定其為本應用程序的實例句柄。threaded 與安裝的鉤子子程相關聯的線程的標識符//如果為0，鉤子子程與所有的線程關聯，即為全局鉤子//************************************//如果SetWindowsHookEx失敗if (hKeyboardHook == 0){Stop();throw new Exception("安裝鍵盤鉤子失敗");}}}public void Stop(){bool retKeyboard = true;if (hKeyboardHook != 0){retKeyboard = UnhookWindowsHookEx(hKeyboardHook);hKeyboardHook = 0;}if (!(retKeyboard)) throw new Exception("卸載鉤子失敗！");}//ToAscii職能的轉換指定的虛擬鍵碼和鍵盤狀態的相應字符或字符[DllImport("user32")]public static extern int ToAscii(int uVirtKey, int uScanCode, byte[] lpbKeyState, byte[] lpwTransKey, int fuState);//獲取按鍵的狀態[DllImport("user32")]public static extern int GetKeyboardState(byte[] pbKeyState);[DllImport("user32.dll", CharSet = CharSet.Auto, CallingConvention = CallingConvention.StdCall)]private static extern short GetKeyState(int vKey);private const int WM_KEYDOWN = 0x100;//KEYDOWNprivate const int WM_KEYUP = 0x101;//KEYUPprivate const int WM_SYSKEYDOWN = 0x104;//SYSKEYDOWNprivate const int WM_SYSKEYUP = 0x105;//SYSKEYUPprivate int KeyboardHookProc(int nCode, Int32 wParam, IntPtr lParam){// 偵聽鍵盤事件if ((nCode >= 0) && (KeyDownEvent != null || KeyUpEvent != null || KeyPressEvent != null)){KeyboardHookStruct MyKeyboardHookStruct = (KeyboardHookStruct)Marshal.PtrToStructure(lParam, typeof(KeyboardHookStruct));// raise KeyDownif (KeyDownEvent != null && (wParam == WM_KEYDOWN || wParam == WM_SYSKEYDOWN)){Keys keyData = (Keys)MyKeyboardHookStruct.vkCode;KeyEventArgs e = new KeyEventArgs(keyData);KeyDownEvent(this, e);}//鍵盤按下if (KeyPressEvent != null && wParam == WM_KEYDOWN){byte[] keyState = new byte[256];GetKeyboardState(keyState);byte[] inBuffer = new byte[2];if (ToAscii(MyKeyboardHookStruct.vkCode, MyKeyboardHookStruct.scanCode, keyState, inBuffer, MyKeyboardHookStruct.flags) == 1){KeyPressEventArgs e = new KeyPressEventArgs((char)inBuffer[0]);KeyPressEvent(this, e);}}// 鍵盤抬起if (KeyUpEvent != null && (wParam == WM_KEYUP || wParam == WM_SYSKEYUP)){Keys keyData = (Keys)MyKeyboardHookStruct.vkCode;KeyEventArgs e = new KeyEventArgs(keyData);KeyUpEvent(this, e);}}//如果返回1，則結束消息，這個消息到此為止，不再傳遞。//如果返回0或調用CallNextHookEx函數則消息出了這個鉤子繼續往下傳遞，也就是傳給消息真正的接受者return CallNextHookEx(hKeyboardHook, nCode, wParam, lParam);}~KeyboardHook(){Stop();}} }

注意事項

需要Revit二次開發全流程教學 的朋友可以聯系我qq：1056295111

本文介紹了如何通過鍵盤事件，來觸發revit中插件在運行時做出相應改變的方法，鼠標事件，大家可以自行摸索，原理一樣；

由于是整個項目中監聽，所以需要Hook技術；

鍵位在設置時，注意不要與操作系統以及revit軟件自帶的快捷鍵沖突。

2019/9/11補充，代碼中的if(over)通常放在循環中，看本篇博文的評論就更清楚了

總結

以上是生活随笔為你收集整理的如何在Revit中监听键盘事件的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。