Logo
HOWTO: Get the Builds in the Team Explorer of Visual Studio from a package

Author: Carlos J. Quintero (Microsoft MVP) Applies to: Microsoft Visual Studio 2012
Date: April 2015   Microsoft Visual Studio 2013
      Microsoft Visual Studio 2015
Introduction

The Team Explorer of Visual Studio 2012 and higher is composed of pages (such as Home, My Work, Pending Changes, Work Items, Builds, etc.) and in turn each page is composed of sections. For example, the Builds page is composed of the My Builds, My Favorite Build Definitions and All Build Definitions sections. While an extension (such as a package) could interact directly as a client with some TFS server or Git Repository, in some cases your extension may be interested in the information of the different pages and sections of the Team Explorer client, for example to provide new pages, new sections inside an existing page, new menu entries in the context menus of the Team Explorer, etc.

More Information

The following package creates a menu command that, when clicked, shows the information about the Builds page. The required assemblies are the following:

  • Microsoft.TeamFoundation.Controls.dll (in folder C:\Program Files (x86)\Microsoft Visual Studio <version>\Common7\IDE\ReferenceAssemblies\v4.5\)
  • Microsoft.TeamFoundation.Build.Controls.dll (in folder C:\Program Files (x86)\Microsoft Visual Studio <version>\Common7\IDE\PrivateAssemblies\)
  • Microsoft.TeamFoundation.Build.Client.dll (in folder C:\Program Files (x86)\Microsoft Visual Studio <version>\Common7\IDE\ReferenceAssemblies\v2.0\)
Language: C#   Copy Code Copy Code (IE only)
using System;
using System.Runtime.InteropServices;
using System.ComponentModel.Design;
using Microsoft.VisualStudio.Shell;

namespace Company.VSPackageTeamExplorer
{
   [PackageRegistration(UseManagedResourcesOnly = true)]
   [InstalledProductRegistration("#110", "#112", "1.0", IconResourceID = 400)]
   [ProvideMenuResource("Menus.ctmenu", 1)]
   [Guid(GuidList.guidVSPackageTeamExplorerPkgString)]
   public sealed class VSPackageTeamExplorerPackage : Package
   {
      public VSPackageTeamExplorerPackage()
      {
      }

      protected override void Initialize()
      {
         base.Initialize();

         // Add our command handlers for menu (commands must exist in the .vsct file)
         OleMenuCommandService mcs = GetService(typeof(IMenuCommandService)) as OleMenuCommandService;
         if (null != mcs)
         {
            // Create the command for the menu item.
            CommandID menuCommandID = new CommandID(GuidList.guidVSPackageTeamExplorerCmdSet,
               (int)PkgCmdIDList.cmdidTeamExplorerInfo);
            MenuCommand menuItem = new MenuCommand(MenuItemCallback, menuCommandID);
            mcs.AddCommand(menuItem);
         }
      }

      private void MenuItemCallback(object sender, EventArgs e)
      {
         Microsoft.TeamFoundation.Controls.ITeamExplorer teamExplorer;

         teamExplorer = base.GetService(typeof(Microsoft.TeamFoundation.Controls.ITeamExplorer))
            as Microsoft.TeamFoundation.Controls.ITeamExplorer;

         ShowBuildsPageInformation(teamExplorer, Microsoft.TeamFoundation.Controls.TeamExplorerPageIds.Builds);
      }

      private void ShowBuildsPageInformation(Microsoft.TeamFoundation.Controls.ITeamExplorer teamExplorer, string pageGuid)
      {
         Microsoft.TeamFoundation.Controls.ITeamExplorerPage teamExplorerPage;
         Microsoft.TeamFoundation.Build.Controls.Extensibility.IBuildsPageExt buildsPageExt;

         teamExplorerPage = teamExplorer.NavigateToPage(new Guid(pageGuid), null);

         buildsPageExt = teamExplorerPage.GetExtensibilityService(
            typeof(Microsoft.TeamFoundation.Build.Controls.Extensibility.IBuildsPageExt))
            as Microsoft.TeamFoundation.Build.Controls.Extensibility.IBuildsPageExt;

         if (buildsPageExt != null)
         {
            ShowBuilds("My Builds", buildsPageExt.Builds);

            ShowBuilds("Selected Builds", buildsPageExt.SelectedBuilds);

            ShowBuildDefinitions("My Favorite Build definitions", buildsPageExt.FavoriteDefinitions);

            ShowBuildDefinitions("Selected Favorite Build definitions", buildsPageExt.SelectedFavoriteDefinitions);

            ShowBuildDefinitions("All Build definitions", buildsPageExt.Definitions);

            ShowBuildDefinitions("Selected All Build definitions", buildsPageExt.SelectedDefinitions);
         }
      }

      private void ShowBuilds(string description, Microsoft.TeamFoundation.Build.Controls.Extensibility.IBuildModel[] builds)
      {
         foreach (Microsoft.TeamFoundation.Build.Controls.Extensibility.IBuildModel build in builds)
         {
            ShowBuild(description, build);
         }
      }

      private void ShowBuild(string description, Microsoft.TeamFoundation.Build.Controls.Extensibility.IBuildModel build)
      {
         System.Text.StringBuilder stringBuilder = new System.Text.StringBuilder();

         stringBuilder.AppendLine(description + ":");
         stringBuilder.AppendLine();

         stringBuilder.AppendLine("Name: " + build.Name);

         stringBuilder.AppendLine("ControllerName: " + build.ControllerName);
         stringBuilder.AppendLine("DefinitionName: " + build.DefinitionName);
         stringBuilder.AppendLine("DefinitionUri: " + build.DefinitionUri);
         stringBuilder.AppendLine("KeepForever: " + build.KeepForever);
         stringBuilder.AppendLine("Priority: " + build.Priority);
         stringBuilder.AppendLine("Reason: " + build.Reason);
         stringBuilder.AppendLine("RequestedFor: " + build.RequestedFor);
         stringBuilder.AppendLine("Status: " + build.Status);
         stringBuilder.AppendLine("Uri: " + build.Uri);

         System.Windows.Forms.MessageBox.Show(stringBuilder.ToString());
      }

      private void ShowBuildDefinitions(string description, 
         Microsoft.TeamFoundation.Build.Controls.Extensibility.IDefinitionModel[] definitions)
      {
         foreach (Microsoft.TeamFoundation.Build.Controls.Extensibility.IDefinitionModel definition in definitions)
         {
            ShowBuildDefinition(description, definition);
         }
      }

      private void ShowBuildDefinition(string description, 
         Microsoft.TeamFoundation.Build.Controls.Extensibility.IDefinitionModel definition)
      {
         System.Text.StringBuilder stringBuilder = new System.Text.StringBuilder();

         stringBuilder.AppendLine(description + ":");
         stringBuilder.AppendLine();

         stringBuilder.AppendLine("Name: " + definition.Name);

         stringBuilder.AppendLine("ControllerName: " + definition.ControllerName);
         stringBuilder.AppendLine("IsFavorite: " + definition.IsFavorite);
         stringBuilder.AppendLine("QueueStatus: " + definition.QueueStatus);
         stringBuilder.AppendLine("TriggerType: " + definition.TriggerType);
         stringBuilder.AppendLine("Uri: " + definition.Uri);

         System.Windows.Forms.MessageBox.Show(stringBuilder.ToString());
      }
   }
}

Related articles



Go to the 'Visual Studio Extensibility (VSX)' web site for more articles like this (Articles section)