Search code examples
visual-studioenvdtevspackage

Can I pass an argument/switch/parameter to a VSPackage MenuCommand?

I was hoping someone here might be able to help me out with this. I'm not the most experienced programmer but I'm making progress on a project.

I've got a need to programmatically interact with Visual Studio. Some success has been had using EnvDTE Interop stuff, but it seems that some of what I need to do needs to be done inside VS so I'm attempting to utilize a VSPackage MenuCommand to do various things. Sorry the vagueness.

I'm currently successfully creating a custom MenuCommand with a VSPackage extension, and also am able to trigger that MenuCommand programmatically from another application using the DTE.

What I'm wondering is: is it possible to define a MenuCommand that CAN take arguments passed along to it from the triggering external application?

Using the VS Package Template in Visual Studio 2012 using the Menu Command option, all my code lives inside this method:

private void MenuItemCallback(object sender, EventArgs e)
    {
        // my code...
    }

There is obviously a lot of other auto-generated code plumbing this all together, but all MY code lives in this method. Is there a way to alter this method so that it will allow parameters to be passed to it? What other changes must I make to the other files to declare/register this differently-functioning method once I do so (if I can)?

For example:

static void Main(string[] args)    
{
    Type visualStudioType = Type.GetTypeFromProgID("VisualStudio.DTE.11.0");
    DTE dte = Activator.CreateInstance(visualStudioType) as DTE;
    dte.MainWindow.Visible = true;
    dte.ExecuteCommand("myCommand");        
}

This works. But what I'd like to do is change that last command to:

dte.ExecuteCommand("myCommand", "myArguments");

When I attempt to do something like this, I receive the following exception: "Command \"myCommand\" does not accept arguments or switches."

Sorry if I'm not being clear. Any help would be greatly appreciated.

Solution

  • Commands created from add-ins accept parameters by default.

    Commands created from packages need to specify the <CommandFlag>AllowParams</CommandFlag> when defining the command in the .vsct file. See: http://msdn.microsoft.com/en-us/library/bb491716.aspx

    And see also this thread:

    IOleComandTarget::exec for commands with parameters https://social.msdn.microsoft.com/Forums/en-US/134983e8-049c-40e1-a212-312fa637698b/iolecomandtargetexec-for-commands-with-parameters?forum=vsx

    Then, it should work, either using dte.ExecuteCommand or dte.Commands.Raise(...). See:

    HOWTO: Pass parameters programmatically to a command from a Visual Studio add-in http://www.visualstudioextensibility.com/articles/add-ins/