在Word中创建CommandBar并显示winform窗体

前段时间有一个需求需要在一个Word文档中选定文字后在右键菜单中添加一个按钮点击后弹出一个WinForm窗体,由于在实际做的过程中遇到了两个问题因此记录下来.具体做法如下:

1. 在vs2005中新建一个 shared Add-in 项目,一步一步Next,到Select An Application Host的时候只钩选 Microsoft Word,然后一直Next到完成,会自动创建一个wordAddin项目并带安装项目.
2. 在项目的Connect.cs中的OnConnection方法中添加代码,这个是启动入口,当Word打开的时候会自动调用这个方法.一下是代码:    public void OnConnection(object application, Extensibility.ext_ConnectMode connectMode, object addInInst, ref System.Array custom){applicationObject = application;addInInstance = addInInst; Word.Application app = application as Word.Application;CreateContextMenu(app);}
3. CreateContextMenu(app)方法,注意此处添加的CommandBarButton必须是全局的,不然其Click事件开始只会触发1~2次,后面将不会触发:
   private Office.CommandBarButton ShowButton; private static Office.CommandBarButton ShowTermButton; public static void CreateContextMenu(Word.ApplicationClass app) { Office.CommandBars commandBars = (Office.CommandBars)app.CommandBars; object missing = System.Reflection.Missing.Value; Office.CommandBar listsbar = commandBars["Lists"]; if (listsbar != null) { ShowButton = (Office.CommandBarButton)listsbar.FindControl(Office.MsoControlType.msoControlButton, missing, Constants.TestForViewParaphrase, true, true); if (ShowButton == null) ShowButton = (Office.CommandBarButton)listsbar.Controls.Add(Office.MsoControlType.msoControlButton, missing, missing, 1, missing); ShowButton.Caption = Constants.TestForViewParaphrase; ShowButton.Style = Microsoft.Office.Core.MsoButtonStyle.msoButtonCaption; ShowButton.Visible = true; ShowButton.Tag = Constants.TestForViewParaphrase; ShowButton.Click += new Microsoft.Office.Core._CommandBarButtonEvents_ClickEventHandler(ShowButton_Click); ShowTermButton = (Office.CommandBarButton)listsbar.FindControl(Office.MsoControlType.msoControlButton, missing, Constants.TextForAddTermNet, true, true); if (ShowTermButton == null) ShowTermButton = (Office.CommandBarButton)listsbar.Controls.Add(Office.MsoControlType.msoControlButton, missing, missing, 1, missing); ShowTermButton.Caption = Constants.TextForAddTermNet; ShowTermButton.Style = Microsoft.Office.Core.MsoButtonStyle.msoButtonCaption; ShowTermButton.Visible = true; ShowTermButton.Tag = Constants.TextForAddTermNet; ShowTermButton.Click += new Microsoft.Office.Core._CommandBarButtonEvents_ClickEventHandler(ShowTermButton_Click); } }
4. 在ShowTermButton_Click事件中将显示一个Form,这里要做特殊处理,就是如何使弹出的窗体自动置于打开的Word之上,在网上找了很久才找到可行的处理方式,是参照http://social.msdn.microsoft.com/forums/en-US/vsto/thread/19539460-14ce-4ea0-9a53-50d38a4eb3b0/ 这个地方来的,代码如下:
   void ShowTermButton_Click(Microsoft.Office.Core.CommandBarButton Ctrl, ref bool CancelDefault) { try { Word.Range range = appClass.ActiveWindow.Selection.Range; if (string.IsNullOrEmpty(range.Text)) return; Form form= new Form(); form.ShowDialog(new WordWin32Window(appClass)); form.Dispose(); } } catch (Exception ex) { Log.Error("Show Form error" + ex); } }
   
   WordWin32Window类代码如下:
   ////// Word example code by H.Obertanner http://www.outlooksharp.de/// Created 2008 with Office 2007 and VSTO 3.0/// Free for non commercial use.using System;using System.Windows.Forms;using System.Runtime.InteropServices;using System.Collections.Generic;using System.Threading;using System.Reflection;using System.Diagnostics;using System.Text;namespace CO.WordLib{ /// <summary> /// This class retrieves the IWin32Window from the current active Word window. /// This could be used to set the parent for Windows Forms and MessageBoxes. /// </summary> /// <example> /// WordWin32Window parentWindow = new WordWin32Window (ThisAddIn.WordApplication); /// MessageBox.Show (parentWindow, "This MessageBox doesn't go behind Word !!!", "Attention !", MessageBoxButtons.Ok , MessageBoxIcon.Question ); /// </example> public class WordWin32Window : IWin32Window { /// <summary> /// Returns a Handle to the Desktop-Window /// </summary> /// <returns>The handle</returns> [DllImport("user32")] private static extern IntPtr GetDesktopWindow(); /// <summary> /// Finds a Window-Handle by its name or classname /// </summary> /// <param name="hwndParent">The Parent Windows-Handle</param> /// <param name="hwndChildAfter">Start the search after the given Windows-Handle</param> /// <param name="lpszClass">The classname to search for</param> /// <param name="lpszWindow">The window caption to search for</param> /// <returns><returns the windows-Handle or IntPtr.Zero</returns> [DllImport("user32")] private static extern IntPtr FindWindowEx(IntPtr hwndParent, IntPtr hwndChildAfter, string lpszClass, string lpszWindow); /// <summary> /// Gets the title of a Window. /// </summary> /// <param name="hWnd">The Windows Handle.</param> /// <param name="lpString">A pointer to a StringBuilder-Object.</param> /// <param name="nMaxCount">Max num of chars to get.</param> [DllImport("user32", CharSet = CharSet.Auto)] private static extern int GetWindowText(IntPtr hWnd, StringBuilder lpString, int nMaxCount); #region IWin32Window Members /// <summary> /// This holds the window handle for the found Window. /// </summary> IntPtr _windowHandle = IntPtr.Zero; /// <summary> /// The <b>Handle</b> of the Word WindowObject. /// </summary> public IntPtr Handle { get { return _windowHandle; } } #endregion /// <summary> /// The <b>WordWin32Window</b> class could be used to get the parent IWin32Window for Windows.Forms and MessageBoxes. /// </summary> /// <param name="wordApp">The Word ApplicationObject.</param> public WordWin32Window(object wordApp) { // how to find my Word Windows-Handle... string oldCaption = (string)wordApp.GetType().InvokeMember("Caption", BindingFlags.GetProperty, null, wordApp, null); // unique identifier string newCaption = Guid.NewGuid().ToString(); // set a new caption to the Word Window wordApp.GetType().InvokeMember("Caption", BindingFlags.SetProperty, null, wordApp, new object[] { newCaption }); // get the Desktop WindowHandle IntPtr hDesktop = GetDesktopWindow(); // Find all Word Windows-Handles // Find the first instance IntPtr hWnd = FindWindowEx(hDesktop, IntPtr.Zero, "OpusApp", null); StringBuilder windowText = new StringBuilder(255); while (hWnd != IntPtr.Zero) { // Get the window-caption GetWindowText(hWnd, windowText, 255); if (windowText.ToString().EndsWith(newCaption)) { // gotcha _windowHandle = hWnd; break; } // Next - starting after the last found window hWnd = FindWindowEx(hDesktop, hWnd, "OpusApp", null); } // Reset the caption wordApp.GetType().InvokeMember("Caption", BindingFlags.PutDispProperty, null, wordApp, new object[] { oldCaption }); } }}
5.  另一个按钮事件，显示气泡:
   void ShowButton_Click(Microsoft.Office.Core.CommandBarButton Ctrl, ref bool CancelDefault) { try { Office.Balloon balloon = appClass.Assistant.NewBalloon; balloon.BalloonType = Office.MsoBalloonType.msoBalloonTypeNumbers; balloon.Button = Office.MsoButtonSetType.msoButtonSetOK; balloon.Heading = "View Text"; balloon.Text = appClass.ActiveWindow.Selection.Text; balloon.Show(); } catch (Exception ex) { } }