和我一起学VSTA（Visual Studio Tools for Applications ）(四)

前三篇简单介绍了VSTA的用途以及开发前期准备，这一篇将介绍具体的开发。

我们先实现一个最简单的功能，打开VSTA IDE编程环境。

首先在VSTASAMPLE项目中，添加如下引用：

 

 

以及：

Microsoft Development Enviroment 8.0.

DTEProvider 1.0 Type Library

 

添加HostItemProvider.cs，代码如下：

 

 1using System;
 2using System.Collections.Generic;
 3using System.Text;
 4using System.AddIn.Contract;
 5using System.AddIn.Contract.Automation;
 6using System.Runtime.Remoting;
 7using Microsoft.VisualStudio.Tools.Applications.Contract;
 8using Microsoft.VisualStudio.Tools.Applications;
 9
namespace VSTASample
{
    internal class HostItemProvider : ContractAdapterBase,
    IHostItemProviderContract
    {
        private VSTAApplication application;

        public HostItemProvider( VSTAApplication application,
            TypeInfrastructureManager typeInfrastructureManager )
            : base(typeInfrastructureManager)
        {
            this.application = application;
        }

        protected override IContract QueryContract( string contractId )
        {
            if(String.Compare(contractId,
                typeof(IHostItemProviderContract).AssemblyQualifiedName,
                StringComparison.Ordinal) == 0)
            {
                return (IContract)this;
            }

            return base.QueryContract(contractId);
        }

        public IRemoteObjectContract GetHostObject( string objectType, string cookie )
        {
            if(String.Compare(objectType,
                typeof(RCS.Common.VSTA.VSTAApplication).FullName,
                StringComparison.Ordinal) == 0)
            {
                RemoteObjectAdapter adapter = new RemoteObjectAdapter(
                    typeof(RCS.Common.VSTA.VSTAApplication),
                    application, TypeInfrastructureManager);
                return adapter;
            }

            throw new ArgumentOutOfRangeException();
        }

        protected override string RemoteToString()
        {
            return this.ToString();
        }

        protected override int GetRemoteHashCode()
        {
            return this.GetHashCode();
        }

        protected override bool RemoteEquals( IContract contract )
        {
            if(contract == null)
                return false;

            if(!System.Runtime.Remoting.RemotingServices.
                IsObjectOutOfAppDomain(contract))
            {
                HostItemProvider contractAdapter =
                    contract as HostItemProvider;
                return this.Equals(contractAdapter);
            }

            return false;
        }
    }
}

 添加一个IDEManagement.cs，代码如下：

 

  1using System;
  2using System.Collections.Generic;
  3using System.Text;
  4using System.Reflection;
  5using System.Windows.Forms;
  6using Microsoft.VisualStudio.Tools.Applications;
  7using Microsoft.VisualStudio.Tools.Applications.Contract;
  8using Microsoft.VisualStudio.Tools.Applications.DesignTime.Interop;
  9using System.AddIn.Contract.Automation;
 10using EnvDTE80;
 11using VSTADTEProvider.Interop;
 12using System.IO;
 13using System.Collections;
 14using EnvDTE;
 15
 16namespace VSTASample
 17{
 18    /**//// <summary>
 19    /// VSTA操作方法类
 20    /// </summary>
 21    internal partial class IDEManagement
 22    {
 23        private VSTAApplication application;
 24        //private Context macroContext;
 25        //private AddInCollection addInCollection;
 26        private IHostItemProviderContract itemProvider;
 27        private TypeInfrastructureManager typeInfrastructureManager;
 28        private EnvDTE.DTE vstaDTE;
 29        private EnvDTE.Project macroProject; 
 30        //private IEntryPointContract[] hostItems;
 31        private string hostID;
 32        private string templateName;
 33
 34        /**//// <summary>
 35        /// 初始化Extension类的新实例。
 36        /// </summary>
 37        internal IDEManagement()
 38        {
 39            InitializeTypeInfrastructureManager();
 40        }
 41
 42        
 43        internal void Connect(VSTAApplication application, string hostID,string templateName)
 44        {
 45            this.application = application;
 46            this.application.IDEManagement = this;
 47            this.hostID = hostID;
 48            this.templateName = templateName;
 49
 50            this.itemProvider = new HostItemProvider(application,TypeInfrastructureManager);
 51            //this.macroPath = @"C:\ShapeAppSamples\MyVSTADLLTest\Macros\bin";
 52            //LoadAddIns();
 53            //InitializeMenus();
 54
 55        }  
 56        
 57       Internal Properties#region Internal Properties
 58
 59        internal TypeInfrastructureManager TypeInfrastructureManager
 60        {
 61            get
 62            {
 63                return typeInfrastructureManager;
 64            }
 65        }
 66        #endregion
 67
 68        /**//// <summary>
 69        /// 打开脚本编程环境
 70        /// </summary>
 71        /// <param name="projectDirectory">脚本程序所在目录</param>
 72        /// <param name="projectFilename">脚本程序工程文件名称(*.vbproj)</param>
 73        /// <returns></returns>
 74        public bool StartIDE(string projectDirectory, string projectFilename)
 75        {
 76            EnsureIDE(hostID);
 77            if (vstaDTE.MainWindow.Visible)
 78            {
 79                //vstaDTE.MainWindow.Activate();
 80                vstaDTE.MainWindow.SetFocus();
 81                return true;
 82            }
 83            else
 84            {
 85                vstaDTE.MainWindow.Visible = true;
 86                vstaDTE.MainWindow.WindowState = EnvDTE.vsWindowState.vsWindowStateMaximize;
 87                string projectFilePath = System.IO.Path.Combine(projectDirectory, projectFilename);
 88                if (System.IO.File.Exists(projectFilePath))
 89                {
 90                    OpenMacroProject(projectFilePath);
 91                }
 92                else
 93                {
 94                    try
 95                    {
 96                        CreateNewMacroProject(projectDirectory, projectFilename);
 97                    }
 98                    catch(Exception e)
 99                    {
                        MessageBox.Show(
                            e.Message,
                            hostID, MessageBoxButtons.OK, MessageBoxIcon.Error);
                        this.vstaDTE.Quit();
                        vstaDTE = null;
                        return false;
                    }
                }
                return true;
            }
        }

        private void EnsureIDE(string hostID)
        {
            if (this.vstaDTE == null)
            {
                try
                {
                    IDTEProvider dteProvider = new VSTADTEProviderClass();
                    //string HostID = "MyVSTADLLTest";
                    UInt32 TimeOut = 10000;
                    vstaDTE = dteProvider.GetDTE(hostID, TimeOut);
                    System.Diagnostics.Debug.Assert(this.vstaDTE != null);
                }
                catch
                {
                    // If DTEProvider does not work, try co-creating DTE instead.
                    object objDTE = new EnvDTE.DTE();
                    this.vstaDTE = (EnvDTE.DTE)objDTE;
                }

                //vstaDTE.MainWindow.Visible = true;
                //增加关闭IDE窗口时关闭vsta.exe进程以及编译
                EnvDTE.CommandEvents commandEvents = vstaDTE.Events.get_CommandEvents("{00000000-0000-0000-0000-000000000000}", 0);

                commandEvents.BeforeExecute += new EnvDTE._dispCommandEvents_BeforeExecuteEventHandler(commandEvents_BeforeExecute);

                //get and subscribe to the File.Exit event prior to execution
                EnvDTE.CommandEvents exitCommand = vstaDTE.Events.get_CommandEvents("{5EFC7975-14BC-11CF-9B2B-00AA00573819}", 229);

                exitCommand.BeforeExecute += new EnvDTE._dispCommandEvents_BeforeExecuteEventHandler(exitCommand_BeforeExecute);
            }
        }

        /**//// <summary>
        /// 关闭IDE
        /// </summary>
        public void ExitIDE()
        {
            if(this.vstaDTE != null)
            {
                if(this.vstaDTE.Mode == EnvDTE.vsIDEMode.vsIDEModeDebug)
                {
                    this.vstaDTE.Debugger.Stop(true);
                }
                this.macroProject.Save(null);
                this.vstaDTE.Quit();
            }
         private void CreateNewMacroProject(string projectDirectory, string projectFileName)
        {
            Solution2 sol = (Solution2)vstaDTE.Solution;
            //string projectTemplatePath = @"C:\ShapeAppSamples\VSTATest\templates\VisualBasic\1033\";
            string projectTemplatePath = sol.GetProjectTemplate(templateName, "VisualBasic");
            //string targetProjectDirectory = @"C:\ShapeAppSamples\MyVSTADLLTest\Macros";
            //string targetProjectFilename = "MyEventSampleMacro.vbproj";

            this.vstaDTE.Solution.AddFromTemplate(projectTemplatePath,projectDirectory, projectFileName, true);
            this.vstaDTE.Solution.SolutionBuild.Build(true);
        }
        
        private void OpenMacroProject(string projectFilePath)
        {
            //string projectFilePath = @"C:\ShapeAppSamples\MyVSTADLLTest\Macros\MyEventSampleMacro.vbproj";
            this.macroProject = this.vstaDTE.Solution.AddFromFile(projectFilePath, true);
            //vstaDTE.MainWindow.Visible = true;
        }

        EnvDTE.CodeElement FindCodeElementInCodeElements(EnvDTE.CodeElements codeElems, EnvDTE.vsCMElement kind, string fullName)
        {
            foreach (EnvDTE.CodeElement codeElem in codeElems)
            {
                if (codeElem.Kind == kind)
                {
                    if (codeElem.FullName == fullName)
                    {
                        if (codeElem.Kind == EnvDTE.vsCMElement.vsCMElementFunction)
                        {
                            EnvDTE.CodeFunction codeFunc = (EnvDTE.CodeFunction)codeElem;
                            if (codeFunc.IsOverloaded)
                            {
                                if (codeFunc.Parameters.Count != 0)
                                {
                                    continue;
                                }
                            }
                        }

                        return codeElem;
                    }
                }
            }

            return null;
        }
        private void exitCommand_BeforeExecute( string Guid, int ID, object CustomIn, object CustomOut, ref bool CancelDefault )
        {
            //Project.IsDirty is always false, so use .Saved which starts true
            if(this.macroProject.Saved == true)
            {
                //prompt the user to save the project
                this.macroProject.Save(null);
                //change the saved state
                this.macroProject.Saved = false;

                this.vstaDTE.Solution.SolutionBuild.Build(true);
            }

            //quit the IDE
            this.vstaDTE.Quit();

            this.vstaDTE = null;
        }

        private void commandEvents_BeforeExecute( string Guid, int ID, object CustomIn, object CustomOut, ref bool CancelDefault )
        {
            EnvDTE.Command objCommand = default(EnvDTE.Command);
            //string sCommandName = null;

            //break here to check out any commands you are interested in
            objCommand = vstaDTE.Commands.Item(Guid, ID);

            //if((objCommand != null))
            //{
            //    sCommandName = objCommand.Name;

            //    if(sCommandName.Equals("Something.WorthWatching"))
            //    {
            //        //do something
            //    }
            //}

        }
        private void InitializeTypeInfrastructureManager()
        {
            if (typeInfrastructureManager == null)
            {
                typeInfrastructureManager = new TypeInfrastructureManager();

                // This was auto-generated from ProxyGen with the /h:hostmapfile commandline argument.

                global::System.Type hostType;
                global::System.Type proxyType;


                                hostType = typeof(global::VSTASample.VSTAApplication);
                proxyType = typeof(NonProxiableType<global::VSTASample.VSTAApplication>);
                typeInfrastructureManager.CanonicalNameToTypeMap.Add("VSTASample, VSTASample.VSTAApplication", proxyType);
                typeInfrastructureManager.TypeToCanonicalNameMap.Add(hostType, "VSTASample, VSTASample.VSTAApplication");
            }
       }
  }
}

这里，我们为了方便不同的项目调用，用一个操作类来发布，添加一个VSTAHelper.cs，代码如下：

 

  1using System;
  2using System.Collections.Generic;
  3using System.Text;
  4using System.Reflection;
  5using EnvDTE;
  6using System.Collections;
  7
  8namespace VSTASample
  9{
 10    /**//// <summary>
 11    /// VSTA操作类
 12    /// </summary>
 13    public class VSTAHelper
 14    {
 15        private static VSTAHelper instance;
 16
 17        /**//// <summary>
 18        /// VSTAHelper类单一实例
 19        /// </summary>
 20        public static VSTAHelper Instance
 21        {
 22            get
 23            {
 24                if(VSTAHelper.instance == null)
 25                {
 26                    VSTAHelper.instance = new VSTAHelper();
 27                }
 28
 29                return VSTAHelper.instance;
 30            }
 31        }
 32
 33        private VSTAApplication app;
 34        /**//// <summary>
 35        /// 初始化类的实例。
 36        /// </summary>
 37        private VSTAHelper()
 38        {
 39            {
 40                app = new VSTAApplication();
 41            }
 42        }
 43
 44        /**//// <summary>
 45        /// 打开脚本编程环境
 46        /// </summary>
 47        /// <returns></returns>
 48        /// <param name="projectDirectory">脚本程序所在目录(如：C:\ShapeAppSamples\MyVSTADLLTest\Macros)</param>
 49        /// <param name="projectFilename">脚本程序工程文件名称(*.vbproj)</param>
 50        /// <example><code>
 51        /// private VSTAHelper vstaHelper = new VSTAHelper();
 52        /// vstaHelper.StartIDE(@"..\Solutions\自动计量\script\Demo","Demo.vbproj");
 53        /// </code></example>
 54        public void StartIDE( string projectDirectory, string projectFilename )
 55        {
 56            //using(MessageFilter messageFilter = new MessageFilter())
 57            {
 58                app.IDEManagement.StartIDE(projectDirectory, projectFilename);
 59            }
 60        }
 61
 62        /**//// <summary>
 63        /// 关闭IDE
 64        /// </summary>
 65        /// <example><code>
 66        /// private VSTAHelper vstaHelper = new VSTAHelper();
 67        /// vstaHelper.ExitIDE();
 68        /// </code></example>
 69        public void ExitIDE()
 70        {
 71            app.IDEManagement.ExitIDE();
 72        }
 73
 74    }
 75    internal partial class VSTAApplication
 76    {
 77        private IDEManagement ideManagement;
 78        /**//// <summary>
 79        /// 操作方法类
 80        /// </summary>
 81        public IDEManagement IDEManagement
 82        {
 83            get
 84            {
 85                if(this.ideManagement == null)
 86                {
 87                    ideManagement = new IDEManagement();
 88                    ideManagement.Connect(this, "VSTAHelper", "dlladdin.zip");
 89                }
 90                return ideManagement;
 91            }
 92            set
 93            {
 94                ideManagement = value;
 95            }
 96        }
 97
 98    }
 99}

编译生成。

下面就是新建个winform项目，使用操作类即可。

VSTASample.VSTAHelper.Instance.StartIDE(projectPath，projectFileName);