Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version

.NET Regular Expressions Find and Replace Add-In for Visual Studio 2008

, 12 Oct 2009 CPOL
A .NET Regular Expressions Find and Replace add-in for Visual Studio 2008
��using System;

using Extensibility;

using EnvDTE;

using EnvDTE80;

using Microsoft.VisualStudio.CommandBars;

using System.Resources;

using System.Reflection;

using System.Globalization;

using System.Windows.Forms;



namespace RegexFindAndReplace

{

    /// <summary>The object for implementing an Add-in.</summary>

    /// <seealso class='IDTExtensibility2' />

    public class Connect : IDTExtensibility2, IDTCommandTarget

    {

        private DTE2 applicationObject;

        private AddIn addInInstance;

        private FindAndReplaceForm findAndReplaceForm;



        /// <summary>Implements the constructor for the Add-in object. Place your initialization code within this method.</summary>

        public Connect()

        {

        }



        /// <summary>Implements the OnConnection method of the IDTExtensibility2 interface. Receives notification that the Add-in is being loaded.</summary>

        /// <param term='application'>Root object of the host application.</param>

        /// <param term='connectMode'>Describes how the Add-in is being loaded.</param>

        /// <param term='addInInst'>Object representing this Add-in.</param>

        /// <seealso class='IDTExtensibility2' />

        public void OnConnection( object application, ext_ConnectMode connectMode, object addInInst, ref Array custom )

        {

            this.applicationObject = (DTE2)application;

            this.addInInstance = (AddIn)addInInst;



            if ( connectMode == ext_ConnectMode.ext_cm_Startup || connectMode == ext_ConnectMode.ext_cm_AfterStartup )

            {

                object[] contextGUIDS = new object[] { };

                Commands2 commands = (Commands2)this.applicationObject.Commands;

                string editMenuName;



                try

                {

                    ResourceManager resourceManager = new ResourceManager( "RegexFindAndReplace.CommandBar", Assembly.GetExecutingAssembly() );

                    CultureInfo cultureInfo = new System.Globalization.CultureInfo( this.applicationObject.LocaleID );

                    string resourceName = string.Concat( cultureInfo.TwoLetterISOLanguageName, "Edit" );

                    editMenuName = resourceManager.GetString( resourceName );

                }

                catch

                {

                    editMenuName = "Edit";

                }



                // Place the command on the edit menu.

                // Find the MenuBar command bar, which is the top-level command bar holding all the main menu items:

                Microsoft.VisualStudio.CommandBars.CommandBar menuBarCommandBar = ( (Microsoft.VisualStudio.CommandBars.CommandBars)this.applicationObject.CommandBars )[ "MenuBar" ];



                //Find the Edit command bar on the MenuBar command bar:

                CommandBarControl editControl = menuBarCommandBar.Controls[ editMenuName ];

                CommandBarPopup editPopup = (CommandBarPopup)editControl;



                int findAndReplaceMenuIndex = -1;



                foreach ( CommandBarControl commandBarControl in editPopup.Controls )

                {

                    if ( commandBarControl.Caption.Contains( "Find and Replace" ) )

                    {

                        findAndReplaceMenuIndex = commandBarControl.Index;

                    }

                }



                CommandBarPopup menuPopup = null;



                if ( findAndReplaceMenuIndex != -1 )

                {

                    CommandBarControl findAndReplaceControl = editPopup.Controls[ findAndReplaceMenuIndex ];

                    menuPopup = (CommandBarPopup)findAndReplaceControl;

                }

                else

                {

                    menuPopup = editPopup;

                }



                // This try/catch block can be duplicated if you wish to add multiple commands to be handled by your Add-in,

                // just make sure you also update the QueryStatus/Exec method to include the new command names.

                try

                {

                    //Add a command to the Commands collection:

                    Command command = commands.AddNamedCommand2( this.addInInstance, "RegexFindAndReplace", "Regex Find and Replace", "Executes the command for RegexFindAndReplace", true, 0, ref contextGUIDS, (int)vsCommandStatus.vsCommandStatusSupported + (int)vsCommandStatus.vsCommandStatusEnabled, (int)vsCommandStyle.vsCommandStylePictAndText, vsCommandControlType.vsCommandControlTypeButton );

                    command.Bindings = "Global::ctrl+shift+x";



                    //Add a control for the command to the edit menu:

                    if ( ( command != null ) && ( editPopup != null ) )

                    {

                        command.AddControl( menuPopup.CommandBar, 1 );

                    }

                }

                catch ( System.ArgumentException )

                {

                    // If we are here, then the exception is probably because a command with that name

                    // already exists. If so there is no need to recreate the command and we can 

                    // safely ignore the exception.

                }

            }

        }



        /// <summary>Implements the OnDisconnection method of the IDTExtensibility2 interface. Receives notification that the Add-in is being unloaded.</summary>

        /// <param term='disconnectMode'>Describes how the Add-in is being unloaded.</param>

        /// <param term='custom'>Array of parameters that are host application specific.</param>

        /// <seealso class='IDTExtensibility2' />

        public void OnDisconnection( ext_DisconnectMode disconnectMode, ref Array custom )

        {

        }



        /// <summary>Implements the OnAddInsUpdate method of the IDTExtensibility2 interface. Receives notification when the collection of Add-ins has changed.</summary>

        /// <param term='custom'>Array of parameters that are host application specific.</param>

        /// <seealso class='IDTExtensibility2' />		

        public void OnAddInsUpdate( ref Array custom )

        {

        }



        /// <summary>Implements the OnStartupComplete method of the IDTExtensibility2 interface. Receives notification that the host application has completed loading.</summary>

        /// <param term='custom'>Array of parameters that are host application specific.</param>

        /// <seealso class='IDTExtensibility2' />

        public void OnStartupComplete( ref Array custom )

        {

        }



        /// <summary>Implements the OnBeginShutdown method of the IDTExtensibility2 interface. Receives notification that the host application is being unloaded.</summary>

        /// <param term='custom'>Array of parameters that are host application specific.</param>

        /// <seealso class='IDTExtensibility2' />

        public void OnBeginShutdown( ref Array custom )

        {

        }



        /// <summary>Implements the QueryStatus method of the IDTCommandTarget interface. This is called when the command's availability is updated</summary>

        /// <param term='commandName'>The name of the command to determine state for.</param>

        /// <param term='neededText'>Text that is needed for the command.</param>

        /// <param term='status'>The state of the command in the user interface.</param>

        /// <param term='commandText'>Text requested by the neededText parameter.</param>

        /// <seealso class='Exec' />

        public void QueryStatus( string commandName, vsCommandStatusTextWanted neededText, ref vsCommandStatus status, ref object commandText )

        {

            if ( neededText == vsCommandStatusTextWanted.vsCommandStatusTextWantedNone )

            {

                if ( commandName == "RegexFindAndReplace.Connect.RegexFindAndReplace" )

                {

                    status = (vsCommandStatus)vsCommandStatus.vsCommandStatusSupported | vsCommandStatus.vsCommandStatusEnabled;

                }

            }

        }



        /// <summary>Implements the Exec method of the IDTCommandTarget interface. This is called when the command is invoked.</summary>

        /// <param term='commandName'>The name of the command to execute.</param>

        /// <param term='executeOption'>Describes how the command should be run.</param>

        /// <param term='varIn'>Parameters passed from the caller to the command handler.</param>

        /// <param term='varOut'>Parameters passed from the command handler to the caller.</param>

        /// <param term='handled'>Informs the caller if the command was handled or not.</param>

        /// <seealso class='Exec' />

        public void Exec( string commandName, vsCommandExecOption executeOption, ref object varIn, ref object varOut, ref bool handled )

        {

            handled = false;



            if ( executeOption == vsCommandExecOption.vsCommandExecOptionDoDefault )

            {

                if ( commandName == "RegexFindAndReplace.Connect.RegexFindAndReplace" )

                {

                    if ( findAndReplaceForm != null )

                    {

                        findAndReplaceForm.Close();

                    }



                    findAndReplaceForm = new FindAndReplaceForm( this.applicationObject );

                    findAndReplaceForm.Show( new DTEWindowWrapper( this.applicationObject ) );



                    handled = true;

                }

            }

        }

    }

}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

jhillman
Software Developer
United States United States
I am a software developer currently working in Salt Lake City, Utah. I work primarily with C# for my job, but I mess around with C, Perl, and Windows PowerShell for fun.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.141216.1 | Last Updated 12 Oct 2009
Article Copyright 2008 by jhillman
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid