使用 Team Foundation 的客户端对象模型为不同类型的工作项编写代码

在其他团队项目中编写代码时,可以执行在的工作项的不同类型的相同功能具有类似的用途。 这些类型可能是不同的,因为它们来自其他过程模板,或者团队可能已自定义这些类为一个特定团队项目。 例如,您可能希望对用户情景和要求的相同功能,这两者均应来表示客户需要和值。 而不是每个工作项类型编写不同的代码,可以对您的代码为两个工作。 此外,团队可能已自定义用户情景的工作项定义,以便团队成员可以估计工作在而不是情景的工时点。 您可避免重复您的工作通过调整您的代码来处理默认值和自定义的方法。

在本主题中,您可以找到执行的特定类型工作项的任务未自定义的代码示例,如何可以了解代码支持某些类型的自定义重构。 有关如何自定义工作项类型的更多信息,请参见 可在 Visual Studio TFS 中配置并自定义的内容的端到端视图

主题内容

  • 用户情景打印树与评估中的情景点

  • 用户情景打印树与评估中的情景点或基线工作

  • 打印的工作项树用作与评估的要求

用户情景打印树与评估中的情景点

此代码示例在每个团队项目打印所有用户情景树在服务器并包括没有子元素的每个情景的估计。 若要使用此示例,您可以创建一个控制台应用程序,添加对下列程序集,用下面的代码替换Program.cs (或Module1.vb)内容。

using System;
using System.Text;
using System.Collections.ObjectModel;
using Microsoft.TeamFoundation.Client;
using Microsoft.TeamFoundation.Framework.Client;
using Microsoft.TeamFoundation.Framework.Common;
using Microsoft.TeamFoundation.WorkItemTracking.Client;

namespace Microsoft.TeamFoundation.SDK
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                // Connect to Team Foundation Server. The form of the url is http://server:port/vpath.
                //     Server - the name of the server that is running the application tier for Team Foundation.
                //     port - the port that Team Foundation uses. The default port is 8080.
                //     vpath - the virtual path to the Team Foundation application. The default path is tfs.
                TfsConfigurationServer configurationServer =
                    TfsConfigurationServerFactory.GetConfigurationServer(new Uri("http://Server:8080/tfs"));
               
                // Get the catalog of team project collections
                CatalogNode catalogNode = configurationServer.CatalogNode;
                ReadOnlyCollection<CatalogNode> tpcNodes = catalogNode.QueryChildren(
                    new Guid[] { CatalogResourceTypes.ProjectCollection }, false, CatalogQueryOptions.None);

                // Process each team project collection
                foreach (CatalogNode tpcNode in tpcNodes)
                {
                    // Use the InstanceId property to get the team project collection
                    Guid tpcId = new Guid(tpcNode.Resource.Properties["InstanceId"]);
                    TfsTeamProjectCollection tpc = configurationServer.GetTeamProjectCollection(tpcId);

                    // Get the work item store
                    WorkItemStore wiStore = tpc.GetService<WorkItemStore>();

                    // Query for the trees of active user stories in the team project collection
                    StringBuilder queryString = new StringBuilder("SELECT [System.Id] FROM WorkItemLinks WHERE ");
                    queryString.Append("([Source].[System.WorkItemType] = 'User Story' AND [Source].[System.State] = 'Active') AND ");
                    queryString.Append("([System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward') And ");
                    queryString.Append("([Target].[System.WorkItemType] = 'User Story' AND [Target].[System.State] = 'Active') ORDER BY [System.Id] mode(Recursive)");
                    Query wiQuery = new Query(wiStore, queryString.ToString());
                    WorkItemLinkInfo[] wiTrees = wiQuery.RunLinkQuery();

                    // Print the trees of user stories, with the estimated sizes of each leaf
                    PrintTrees(wiStore, wiTrees, "    ", 0, 0);
                }
            }

            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }

        // Each WorkItemLinkInfo structure in the collection contains the IDs of the linked work items.
        // In this case, the sourceId is the ID of the user story that is on the parent side of the link, and
        // the targetId is the ID of the user story that is on the child side of the link. The links
        // are returned in depth-first order. This function recursively traverses the collection
        // and the title of each user story. If the user story has no children, its estimation is also printed.
        static int PrintTrees(WorkItemStore wiStore, WorkItemLinkInfo[] wiTrees, string prefix, int sourceId, int iThis)
        {
            int iNext = 0;

            // Get the parent of this user story, if it has one
            WorkItem source = null;
            if (sourceId != 0)
            {
                source = wiStore.GetWorkItem(wiTrees[iThis].SourceId);
            }

            // Process the items in the list that have the same parent as this user story
            while (iThis < wiTrees.Length && wiTrees[iThis].SourceId == sourceId)
            {
                // Get this user story
                WorkItem target = wiStore.GetWorkItem(wiTrees[iThis].TargetId);
                Console.Write(prefix);
                Console.Write(target.Type.Name);
                Console.Write(": ");
                Console.Write(target.Fields["Title"].Value);
                if (iThis < wiTrees.Length - 1)
                {
                    if (wiTrees[iThis].TargetId == wiTrees[iThis + 1].SourceId)
                    {
                        // The next item is this user story's child. Process the children
                        Console.WriteLine();
                        iNext = PrintTrees(wiStore, wiTrees, prefix + "    ", wiTrees[iThis + 1].SourceId, iThis + 1);
                    }
                    else
                    {
                        // The next item is not this user story's child.
                        Console.Write("; estimate = ");
                        Console.WriteLine(target.Fields["Story Points"].Value);
                        iNext = iThis + 1;
                    }
                }
                else
                {
                    // This user story is the last one.
                    iNext = iThis + 1;
                }

                iThis = iNext;
            }

            return iNext;
        }
    }
}
Imports System
Imports System.Text
Imports System.Collections.ObjectModel
Imports Microsoft.TeamFoundation.Client
Imports Microsoft.TeamFoundation.Framework.Client
Imports Microsoft.TeamFoundation.Framework.Common
Imports Microsoft.TeamFoundation.WorkItemTracking.Client

Module Module1
    Sub Main(ByVal sArgs() As String)

        Try
            ' Connect to the Team Foundation Server. The form of the url is http://server:port/vpath.
            ' Server - the name of the server that is running the application tier for Team Foundation
            ' Port - the port that Team Foundation uses. The default port is 8080.
            ' Vpath - the virtual path to the Team Foundation application. The default is tfs.

            Dim tfsUri As New Uri("http://Server:8080/tfs")
            Dim configurationServer As TfsConfigurationServer
            configurationServer = TfsConfigurationServerFactory.GetConfigurationServer(tfsUri)

            ' Get the catalog of team project collections
            Dim catalogNode As CatalogNode
            catalogNode = configurationServer.CatalogNode
            Dim tpcNodes As ReadOnlyCollection(Of CatalogNode)
            Dim gVar As Guid() = New Guid() {CatalogResourceTypes.ProjectCollection}
            tpcNodes = catalogNode.QueryChildren(gVar, False, CatalogQueryOptions.None)
            ' Process each team project collection
            For Each tpcNode In tpcNodes
                Dim tpcGuid As Guid = New Guid(tpcNode.Resource.Properties("InstanceID"))
                Dim tpc As New TfsTeamProjectCollection(tfsUri)
                tpc = configurationServer.GetTeamProjectCollection(tpcGuid)
                ' Get the work item store
                Dim wiStore As WorkItemStore
                wiStore = tpc.GetService(Of WorkItemStore)()
                ' Query for the trees of active user stories in the team project collection
                Dim queryString As New StringBuilder("SELECT [System.ID] FROM WorkItemLinks WHERE ")
                queryString.Append("([Source].[System.WorkItemType] = 'User Story' AND [Source].[System.State] = 'Active') AND ")
                queryString.Append("([System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward') And ")
                queryString.Append("([Target].[System.WorkItemType] = 'User Story' AND [Target].[System.State] = 'Active') ORDER BY [System.Id] mode(Recursive)")
                Dim wiQuery As New Query(wiStore, queryString.ToString())
                Dim wiTrees() As WorkItemLinkInfo
                wiTrees = wiQuery.RunLinkQuery()

                ' Print the trees of user stories with the estimated size of each leaf.
                PrintTrees(wiStore, wiTrees, "   ", 0, 0)
            Next

        Catch ex As Exception
            Console.WriteLine(ex.Message)

        End Try
        


    End Sub

    ' Each WorkItemLinkInfo structure in the collection contains the IDs of the linked work items.
    ' In this case, the sourceId is the ID of the user story that is on the parent side of the link, and
    ' the targetId is the ID of the user story that is on the child side of the link. The links
    ' are returned in depth-first order. This function recursively traverses the collection
    ' and the title of each user story. If the user story has no children, its estimation is also printed.

    Function PrintTrees(ByVal wiStore As WorkItemStore, ByVal wiTrees As WorkItemLinkInfo(), ByVal prefix As String, ByVal sourceId As Integer, ByVal iThis As Integer) As Integer

        Dim iNext As Integer = 0

        ' Get the parent of this user story, if it has one
        Dim source As WorkItem = Nothing

        If sourceId <> 0 Then
            source = wiStore.GetWorkItem(wiTrees(iThis).SourceId)
        End If

        ' Process the items in the list that have the same parent as this user story
        While (iThis < wiTrees.Length AndAlso wiTrees(iThis).SourceId = sourceId)
            ' Get this user story

            Dim target As WorkItem
            target = wiStore.GetWorkItem(wiTrees(iThis).TargetId)
            Console.Write(prefix)
            Console.Write(target.Type.Name)
            Console.Write(":  ")
            Console.Write(target.Fields("Title").Value)
            If iThis < (wiTrees.Length - 1) Then
                If wiTrees(iThis).TargetId = wiTrees(iThis + 1).SourceId Then

                    ' The next item is the user story's child.
                    Console.WriteLine()
                    iNext = PrintTrees(wiStore, wiTrees, prefix + "   ", wiTrees(iThis + 1).SourceId, iThis + 1)
                Else

                    ' The next item is not the user story's child
                    Console.Write("; estimate = ")
                    Console.WriteLine(target.Fields("Story Points").Value)
                    iNext = iThis + 1
                End If
            Else
                ' This user story is the last one.
                iNext = iThis + 1
            End If
            iThis = iNext
        End While
        Return iNext
    End Function

End Module

用户情景打印树与评估中的情景点或基线工作

此示例修改PrintTrees方法确定每个工作项是否使用该情景点字段或基线工作字段和打印从该字段的估计。 若要使用此示例,您可以用以下代码替换该PrintTrees方法的行 Console.WriteLine(target.Fields["Story Points"].Value); 。

// Determine which estimation field is present
string fieldName = "Story Points";
if (target.Type.FieldDefinitions.TryGetByName(fieldName) == null) 
{
    fieldName = "Baseline Work";
}
Console.WriteLine(target.Fields[fieldName].Value); 
Dim fieldName As String
fieldName = "Story Points"
If (target.Type.FieldDefinitions.TryGetByName(fieldName) Is Nothing) Then
    fieldName = "Baseline Work"
End If
Console.WriteLine(target.Fields(fieldName).Value)

打印整个树项类别的项目

可将到的工作项的类别不同的类型为相同或相似的用途在不同的团队项目。 您可以对所属类别的所有工作项的相同功能的代码。 此示例在要求类别打印任何工作项类型的估计,如用户情景、要求和产品积压工作项。

若要使用此示例,用以下代码替换前个示例的主函数。

static void Main(string[] args) 
{
    try
    {
        // Connect to Team Foundation Server. The form of the url is http://server:port/vpath.
        //     server - the name of the server that is running the application tier for Team Foundation.
        //     port - the port that Team Foundation uses. The default ort is 8080.
        //     vpath - the virtual path to the Team Foundation application. The default path is tfs. 
        TfsConfigurationServer configurationServer =
            TfsConfigurationServerFactory.GetConfigurationServer(new Uri("http://server:8080/tfs"));

        // Get the catalog of team project collections
        CatalogNode catalogNode = configurationServer.CatalogNode; 
        ReadOnlyCollection<CatalogNode> tpcNodes = catalogNode.QueryChildren(
            new Guid[] { CatalogResourceTypes.ProjectCollection }, false, CatalogQueryOptions.None); 

        // Process each team project collection
        foreach (CatalogNode tpcNode in tpcNodes) 
        {
            // Use the InstanceId property to get the team project collection
            Guid tpcId = new Guid(tpcNode.Resource.Properties["InstanceId"]);
            TfsTeamProjectCollection tpc = configurationServer.GetTeamProjectCollection(tpcId); 

            // Get the work item store
            WorkItemStore wiStore = tpc.GetService<WorkItemStore>();
            foreach (Project project in wiStore.Projects)
            {
                Console.Write("Project: ");
                Console.WriteLine(project.Name); 

                // Get the type of work item to use 
                CategoryCollection categories = wiStore.Projects[project.Name].Categories; 
                string wiType = categories["Requirement Category"].DefaultWorkItemType.Name;

                // Query for the trees of active user stories in the team project collection
                StringBuilder queryString = new StringBuilder("SELECT [System.Id] FROM WorkItemLinks WHERE ");
                queryString.Append("([Source].[System.WorkItemType] = '"); 
                queryString.Append(wiType); 
                queryString.Append("' AND [Source].[System.TeamProject] = '"); 
                queryString.Append(project.Name);
                queryString.Append("') AND ");
                queryString.Append("([System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward') And ");
                queryString.Append("([Target].[System.WorkItemType] = 'User Story'  AND  ");
                queryString.Append("[Target].[System.State] = 'Active') ORDER BY [System.Id] mode(Recursive)"); 
                Query wiQuery = new Query(wiStore, queryString.ToString());
                WorkItemLinkInfo[] wiTrees = wiQuery.RunLinkQuery();

                // Print the trees of user stories and requirements, with the estimated size of each leaf

                PrintTrees(wiStore, wiTrees, "    ", 0, 0); 
            }
        }
    }

    catch (Exception e) 
    {
        Console.WriteLine(e.Message); 
    }
}
Sub Main(ByVal sArgs() As String)

        Try
            ' Connect to the Team Foundation Server. The form of the url is http://server:port/vpath.
            ' Server - the name of the server that is running the application tier for Team Foundation
            ' Port - the port that Team Foundation uses. The default port is 8080.
            ' Vpath - the virtual path to the Team Foundation application. The default is tfs.

            Dim tfsUri As New Uri("http://server:8080/tfs")
            Dim configurationServer As TfsConfigurationServer
            configurationServer = TfsConfigurationServerFactory.GetConfigurationServer(tfsUri)

            ' Get the catalog of team project collections
            Dim catalogNode As CatalogNode
            catalogNode = configurationServer.CatalogNode
            Dim tpcNodes As ReadOnlyCollection(Of CatalogNode)
            Dim gVar As Guid() = New Guid() {CatalogResourceTypes.ProjectCollection}
            tpcNodes = catalogNode.QueryChildren(gVar, False, CatalogQueryOptions.None)
            ' Process each team project collection
            For Each tpcNode In tpcNodes
                Dim tpcGuid As Guid = New Guid(tpcNode.Resource.Properties("InstanceID"))
                Dim tpc As New TfsTeamProjectCollection(tfsUri)
                tpc = configurationServer.GetTeamProjectCollection(tpcGuid)
                ' Get the work item store

                Dim wiStore As WorkItemStore
                wiStore = tpc.GetService(Of WorkItemStore)()
                ' Query for the trees of active user stories in the team project collection
                Dim project As Project
                For Each project In wiStore.Projects
                    Console.Write("Project: ")
                    Console.WriteLine(project.Name)

                    ' Get the type of work item to use
                    Dim categories As CategoryCollection
                    categories = wiStore.Projects(project.Name).Categories
                    Dim wiType As String
                    wiType = categories("Requirement Category").DefaultWorkItemType.Name
                    ' Query for the trees of active user stories in the team project collection
                    Dim queryString As New StringBuilder("SELECT [System.Id] FROM WorkItemLinks WHERE ")
                    queryString.Append("([Source].[System.WorkItemType] = '") 
                    queryString.Append(wiType) 
                    queryString.Append("' AND [Source].[System.TeamProject] = '") 
                    queryString.Append(project.Name)
                    queryString.Append("') AND ")
                    queryString.Append("([System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward') And ")
                    queryString.Append("([Target].[System.WorkItemType] = 'User Story' AND [Target].[System.State] = 'Active') ORDER BY [System.Id] mode(Recursive)")
                    Dim wiQuery As New Query(wiStore, queryString.ToString())
                    Dim wiTrees() As WorkItemLinkInfo
                    wiTrees = wiQuery.RunLinkQuery()

                    ' Print the trees of user stories with the estimated size of each leaf.
                    PrintTrees(wiStore, wiTrees, "   ", 0, 0)
                Next
                
            Next

        Catch ex As Exception
            Console.WriteLine(ex.Message)

        End Try
    End Sub