Create work item in code editor

 

 

Some developers or testers may find that it will be more convenient that they could create a bug in code editor. Select a method, right click and create a work item.

Following steps and sample codes is for VS2010 and .NET4.0.

1 Create a VS Add-in project

2 Add new entry to the context menu of code editor.

The add-in class Connect will implement interface IDTExtensibility2

namespace Extensibility
{
    [Guid("B65AD801-ABAF-11D0-BB8B-00A0C90F2744")]
    [TypeLibType(4160)]
    public interface IDTExtensibility2
    {
        [DispId(3)]
        void OnAddInsUpdate(ref Array custom);
        [DispId(5)]
        void OnBeginShutdown(ref Array custom);
        [DispId(1)]
        void OnConnection(object Application, ext_ConnectMode ConnectMode, object AddInInst, ref Array custom);
        [DispId(2)]
        void OnDisconnection(ext_DisconnectMode RemoveMode, ref Array custom);
        [DispId(4)]
        void OnStartupComplete(ref Array custom);
    }
}

Implement method OnConnection with following code

public void OnConnection(object application, ext_ConnectMode connectMode, object addInInst, ref Array custom)
        {
            _applicationObject = (DTE2)application;
            _addInInstance = (AddIn)addInInst;
            if(connectMode == ext_ConnectMode.ext_cm_UISetup)
            {
                object []contextGUIDS = new object[] { };
                Commands2 commands = (Commands2)_applicationObject.Commands;
                string toolsMenuName = "Code Window";


                //Place the command on the tools 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)_applicationObject.CommandBars)["Editor Context Menus"];

                //Find the Tools command bar on the MenuBar command bar:
                CommandBarControl toolsControl = menuBarCommandBar.Controls[toolsMenuName];
                CommandBarPopup toolsPopup = (CommandBarPopup)toolsControl;

                //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(_addInInstance, "CreateWorkItem", "CreateWorkItem", "Executes the command for CreateWorkItem", true, 59, ref contextGUIDS, (int)vsCommandStatus.vsCommandStatusSupported + (int)vsCommandStatus.vsCommandStatusEnabled, (int)vsCommandStyle.vsCommandStylePictAndText, vsCommandControlType.vsCommandControlTypeButton);

                    //Add a control for the command to the tools menu:
                    if((command != null) && (toolsPopup != null))
                    {
                        command.AddControl(toolsPopup.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.
                }
            }
        }

  3 Handle the command when the menu is clicked

The add-in class Connect will implement interface IDTCommandTarget

public interface IDTCommandTarget
   {
       [DispId(2)]
       void Exec(string CmdName, vsCommandExecOption ExecuteOption, ref object VariantIn, ref object VariantOut, ref bool Handled);
       [DispId(1)]
       void QueryStatus(string CmdName, vsCommandStatusTextWanted NeededText, ref vsCommandStatus StatusOption, ref object CommandText);
   }

When the menu is click, the method Exec is called.

In the Exec command, show a dialog to choose work item type.

public void Exec(string commandName, vsCommandExecOption executeOption, ref object varIn, ref object varOut, ref bool handled)
        {
            handled = false;
            if(executeOption == vsCommandExecOption.vsCommandExecOptionDoDefault)
            {
                if (commandName == "CreateWorkItem.Connect.CreateWorkItem")
                {
                    Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt tfsExt
                       = (Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt)_applicationObject.GetObject("Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt");

                    //Confirm that TFS is connected
                    if ((tfsExt == null)
                        || (tfsExt.ActiveProjectContext == null)
                        || (tfsExt.ActiveProjectContext.DomainUri == null)
                        || (tfsExt.ActiveProjectContext.ProjectUri == null))
                    {
                        MessageBox.Show("Please Connect to TFS first and select a Team Project");
                    }

                    WorkItemTypeSelect witselect = new WorkItemTypeSelect();
                    witselect._applicationObject = _applicationObject;
                    witselect.ShowDialog();

                    handled = true;
                    return;
                }
            }
        }

The UI of the dialog is like

The codes are

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using EnvDTE80;
using Microsoft.TeamFoundation.Client;
using Microsoft.VisualStudio.TeamFoundation.WorkItemTracking;
using Microsoft.TeamFoundation.WorkItemTracking.Client;

namespace CreateWorkItem
{
    public partial class WorkItemTypeSelect : Form
    {
        public DTE2 _applicationObject { get; set; }
        Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt tfsExt;
        DocumentService witDocumentService;
        TfsTeamProjectCollection tfsProjectCollection;
        WorkItemStore wiStore;

        public WorkItemTypeSelect()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {

            WorkItem wi = new WorkItem(wiStore.Projects[tfsExt.ActiveProjectContext.ProjectName].WorkItemTypes[listBox1.SelectedItem.ToString()]);

            wi.Title = listBox1.SelectedItem.ToString();

            dynamic selection = _applicationObject.ActiveDocument.Selection;
            wi.Description = selection.Text;

            IWorkItemDocument widoc = null;
            widoc = witDocumentService.CreateWorkItem(wi,
                new object());
            try
            {
                witDocumentService.ShowWorkItem(widoc);
            }
            finally
            {
                widoc.Release(this);
            }
            this.Close();
        }

        private void WorkItemTypeSelect_Load(object sender, EventArgs e)
        {
            tfsExt = (Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt)_applicationObject.GetObject("Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt");

            witDocumentService = (DocumentService)_applicationObject.GetObject("Microsoft.VisualStudio.TeamFoundation.WorkItemTracking.DocumentService");

            tfsProjectCollection = TfsTeamProjectCollectionFactory.GetTeamProjectCollection(new Uri(tfsExt.ActiveProjectContext.DomainUri));

            wiStore = tfsProjectCollection.GetService<WorkItemStore>();

            listBox1.Items.Clear();
            foreach (WorkItemType wit in wiStore.Projects[tfsExt.ActiveProjectContext.ProjectName].WorkItemTypes)
            {
                listBox1.Items.Add(wit.Name);
            }


        }
    }
}

Note that in MSF for Agile 5, description is not displayed in Bug work item, you can

set the field Microsoft.VSTS.TCM.ReproSteps.

The final result is