如何在Revit中监听键盘事件

欢迎加入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中监听键盘事件的全部内容，希望文章能够帮你解决所遇到的问题。

如果觉得生活随笔网站内容还不错，欢迎将生活随笔推荐给好友。