DotNetRefEdit

Examples of RefEdit like controls for Excel add-ins using C# and ExcelDna

Overview

This project is a proof of concept. This is not a library to be reused in other solutions.

The purpose is to show how to build a .Net UI using WinForm or WPF, within an Excel add-in, where the user can select a range in Excel in order to see the range address appear in the UI control.

Illustration

Step 1: open a form and focus to a "RefEdit" control

Step 2: select a range into Excel

Result: the range address is populated automatically into the "RefEdit" control into the form

Inventory

Several projects can be found on the internet which propose to implement the equivalent of the RefEdit control for .Net programs. But as far as I know, none of these projects show how to manage the window itself. Here is a list of issues I faced in the past:

If the UI runs in the Excel thread, then it will freeze when Excel is busy.
If the UI runs in the Excel thread, then in some conditions it may be impossible for the user to manually edit a control within the UI because Excel will activate and put the focus to the last selected cell. The conditions to reproduce this are quite unclear to me though.
If the UI runs in its own thread, then the user will need to click twice into Excel in order to select a range. Actually, the first click will activate the window and then Excel will discard the message. The second click is to select the range into the activated window.

Links:

Solution

The best option, according to me, is to run the UI in its own thread. The "must-click-twice" issue described above can be resolved by hooking the WH_CALLWNDPROC messages: if the message is of type "WM_MOUSEACTIVATE" and if the handle is an Excel workbook window (in which case, the window name will be "EXCEL7") then it is possible to set the focus to that window before Excel processes the message.

Hook

_hHookCwp = SetWindowsHookEx(HookType.WH_CALLWNDPROC, _procCwp, (IntPtr)0, excelThreadId);

Check the class name

GetClassNameW(cwpStruct.hwnd, cname, cname.Capacity);
if (cname.ToString() == "EXCEL7")

Set the focus

SetFocus(cwpStruct.hwnd);

Bonus: using the same hook, it is possible to notify the UI when the user clicks on the same cell as before. In fact, the UI is notified of a new selection by the Excel event "SheetSelectionChange", but this event is not triggered if the user points to the same cell again. By adding a special notification to the UI inside the hook method, it is possible to resolve that issue.

Code

The solution available along with this project proposes 4 examples, all accessible from the Excel ribbon. These examples have been tested with Excel 2010 32bit, Excel 2013 32bit and Excel 2013 64bit, running on Windows 7 64bit.

The "Excel Thread" buttons launch a WinForm and a WPF window running in the Excel main thread. The "Separate Thread" buttons launch the same UIs in their own threads.

When the UI is launched, it will subscribe to the "SheetSelectionChange" event and hook the WH_CALLWNDPROC messages. For more details on how to hook Windows messages, please refer to https://msdn.microsoft.com/en-us/library/windows/desktop/ms644959%28v=vs.85%29.aspx

The hook method "CwpProc" will apply a specific treatment to WM_MOUSEACTIVATE messages.

Verify the window name. If the name is not "EXCEL7" then skip the treatment and call next hook.

https://msdn.microsoft.com/en-us/library/windows/desktop/ms633582%28v=vs.85%29.aspx

Set the focus to the window using SetFocus.

https://msdn.microsoft.com/en-us/library/windows/desktop/ms646312%28v=vs.85%29.aspx

Notify the UI so it can populate the current selection's address into the "RefEdit" control.

I also included some features like the "F4" shortcut to convert the address, but this is not the main purpose of this project so I will not run into the details.

Demonstration

Note: DotNetRefEdit.xll is for Excel 32bit, DotNetRefEdit64.xll is for Excel 64bit.

Open the add-in and set "12" in A1 inside the active worksheet. Set "1", "2", 3" and "4" respectively in B1, B2, C1 and C2.
Click on button "WinForm" in the "Separate Thread" section. Then click on the first text box, next to "Augend".

Select A1 in the worksheet. This is possible in one click. Finally "[Book1]Sheet1!A1" shall appear in the text box.
Now focus on the second text box, next to "Addend". Then select "B1:C2" in the worksheet. Once again this is possible in one click. Finally, "[Book1]Sheet1!B1:C2" will appear in the text box.
The form will evaluate the sum automatically and "22" will appear in the box next to "Evaluation".
Now select the output, let's say "A5", in the destination box. Finally click on the "Insert" button and this will insert the formula into A5: "=SUM(Sheet1!A1,Sheet1!B1:C2 )"

Focus to the first box again, remove the address. Now go to the worksheet, edit A1 and copy the value. Without escaping from the cell edition, return to the UI and paste the text into the text box. It works because the UI runs in its own thread so it is not frozen when Excel is busy.
Focus to the "Augend" box and select A1. This will populate "[Book1]Sheet1!A1" into that box.
Now focus on the "Addend" box and select A1 again. The address will appear into the box, despite the "SheetSelectionChange" event was not raised.

Conclusion

First, I want to thank Govert from the ExcelDna project, for all the help he provided in order to resolve these issues. Big thanks also for the ExcelDna project itself, which is amazing.

https://github.com/Excel-DNA/ExcelDna

The DotNetRefEdit project demonstrates that it is possible to create .Net add-ins for Excel where UIs can behave like function wizards and allow range selections into Excel, in an user-friendly way.

The "RefEdit" control itself is not hard to implement. The main difficulty resides in the window management. The solution is quite simple once you know it: hook the WH_CALLWNDPROC messages using the SetWindowsHookEx function ; when the hooked message is a WM_MOUSEACTIVATE and the underlying window is a workbook, then call SetFocus.

Excel-DNA/DotNetRefEdit