Microsoft.TeamFoundation.WorkItemTracking.Client 命名空间

TeamFoundation.WorkItemTracking.Client 命名空间提供需要启用客户端计算机或应用程序与用户情景、要求、任务、bug 和工作项时使用的其他类型的 API。

WorkItemStore 表示与工作项的储存库连接在 Visual Studio Team Foundation Server的。 WorkItem 对象包含 Field的存储数据、Attachment表示的文件和 WorkItemLink的连接到其他工作项。 下面的代码示例阐释如何访问存储在工作项中的“用户情景”工作项类型。

// Connect to the server and the store, and get the WorkItemType object
// for user stories from the team project where the user story will be created. 
Uri collectionUri = (args.Length < 1) new Uri("http://server:port/vdir/DefaultCollection") : new Uri(args[0]);
TfsTeamProjectCollection tpc = new TfsTeamProjectCollection(collectionUri);
WorkItemStore workItemStore = tpc.GetService<WorkItemStore>();
Project teamProject = workItemStore.Projects["DinnerNow"];
WorkItemType workItemType = teamProject.WorkItemTypes["User Story"];

Query 选件类表示查询有关 WorkItemStore。 已执行的查询返回 WorkItemCollection，包含工作项满足查询。

WorkItemType 选件类定义工作项。 FieldDefinition 选件类定义了工作项的字段。 WorkItemLinkType 选件类定义 WorkItemLink，链接两个工作项。

可以找到在 \ Program Files \ Microsoft Visual Studio 10.0 \ Common7 \ IDE \ ReferenceAssemblies \ v2.0 的 Microsoft.TeamFoundation.WorkItemTracking.Client 命名空间 团队资源管理器 安装的计算机上，以下程序集中：

• Microsoft.TeamFoundation.WorkItemTracking.Client.dll

类

	类	说明
	Administration	类别以便管理任务可以执行存储在工作项中。
	AllowedValuesCollection	表示有效值列表 Field的。
	Attachment	描述了对工作项的文件附件。
	AttachmentCollection	存储与工作项附件。
	BatchReadParameter	表示 ID，并将添加到 BatchReadParameterCollection 的版本匹配。
	BatchReadParameterCollection	表示从批中读取的参数的集合。
	BatchSave	表示方法，并批保存工作项的属性链接。
	BatchSaveError	类别描述一个工作项的批保存错误。
	BatchSaveFailedException	批保存失败的错误的选件类。
	BatchSaveRetryFailedException	对于批保存的重试次数过程中，生成的错误类别。
	CancelableAsyncResult	类用于访问该异步操作状态或移除结果。
	CannotChangePageSizeException	已过时。类别以尝试可以更改页大小错误。
	Category	描述工作项类型的类别。
	CategoryCollection	类对象的集合。
	ClientException	所有客户端上生成的异常的基类。
	ConnectionException	类别描述连接失败到服务器。
	CoreFieldReferenceNames	类包含引用名称为内核字段。
	CoreLinkTypeReferenceNames	类包含引用名称为内核链接类型。
	DeniedOrNotExistException	类别描述访问被拒绝否则项不存在异常。
	DisplayFieldList	表示从服务器上调用 WorkItemFieldDefinitions 的集合，在 WorkItemCollection 的 WorkItems 访问时。
	DuplicateBatchReadParameterException	重复批处理的选件类读取参数错误。
	DuplicateWorkItemException	已过时。重复工作项错误的选件类。
	ExternalLink	表示指向其他工具。
	Field	表示在 WorkItem的字段。
	FieldCollection	表示 Fields 的集合。WorkItem 对象的。
	FieldConflict
	FieldDefinition	表示 Field的属性。
	FieldDefinitionCollection	描述 FieldDefinition 对象的集合。
	FieldDefinitionNotExistException	当字段定义不存在时，为错误类中。
	FieldFilter	表示可用于建模 FieldDefinition 对象的一个字段值对。用于将 FieldFilterList 一起筛选允许字段的值。
	FieldFilterList	表示的字段筛选器列出使用查询，可以排序。
	FileAttachmentException	文件附件错误的选件类。
	Hyperlink	表示超链接。链接类型为 URL、UNC 或 BIS URI。
	IdentityNotExistException	当身份不存在于集合时，为错误类中。
	ImportEventArgs	导入事件的参数。
	ImportStructureException	为工作项类型的导入过程中，生成的错误类别。
	ImportWorkItemLinkTypeException	对无效的查询文本错误类别。
	ImportWorkitemTypeException	为工作项类型的导入过程中，生成的错误类别。
	InternalAdmin
	InternalDatastoreException	一个错误的异常在内部数据存储区。
	InternalFields	定义任何内置字段引用名称。
	InvalidFieldValueException	为生成的错误类别，当尝试写入字段中的值无效。
	InvalidProjectException	已过时。无效项目错误的选件类。
	InvalidQueryTextException	对无效的查询文本错误类别。
	InvalidTreeNodeException	无效的树节点错误的选件类。
	ItemAlreadyUpdatedOnServerException	为服务器错误已更新的项类别。
	Link	描述链接的实现。
	LinkCollection	表示属于工作项链接对象的集合。
	MetadataEventArgs	元数据的参数更改事件。
	Node	描述用于跟踪数据结构的工作项的一个节点对象。
	NodeCollection	表示节点对象的集合。
	OMStringUtil
	PageSizeRangeException	为页大小范围的错误类别。
	Project	表示工作项跟踪项目。
	ProjectCollection	表示项目的集合。
	Query	表示查询对工作项跟踪的服务。
	QueryDefinition	表示查询。
	QueryFolder	表示在可以包含 QueryDefinitions 和其他 QueryFolders 的团队项目的文件夹。
	QueryFolderContentsChangedEventArgs	QueryFolderContentsChanged 事件的事件参数。
	QueryHierarchy	表示项目的顶级文件夹。
	QueryHierarchyException	为工作项存储的层次结构，查询期间发生的错误类别。
	QueryHierarchyProvider
	QueryHierarchyRefreshData
	QueryItem	查询文件夹和查询定义的基类。
	ReadOnlyFieldException	对于尝试类别写入只读字段错误。
	RegisteredLinkType	描述已注册的链接类型。
	RegisteredLinkTypeCollection	有效的注册链接类型的集合。
	RelatedLink	链接在同一工作项的两个工作项对象在内存中存储和。
	ReportingAttributes	描述字段的报告特性。
	RequestCancelledByUserException	为用户取消错误的请求类别。
	RequestNotCancelableException	类别以尝试可以移除一个 noncancelable 请求错误。
	Revision	表示工作项版本状态。
	RevisionCollection	表示工作项的修订历史记录。
	Schemas	包含与架构相关的方法的抽象类。
	Server	用于的选件类进行服务器调用。
	ServerInfo	此选件类显示有关服务器的信息。
	ServerRejectedChangesException	拒绝的服务器的选件类更改错误。
	SortField	表示 WorkItem可 用于对查询结果进行排序Field。
	SortFieldList	表示可由查询的排序 SortField中的集合。
	StoredQueriesChangedEventArgs	参数或 StoredQueriesChanged 事件。
	StoredQuery	表示一个已存储的查询。
	StoredQueryCollection	表示从项目或工作项存储的存储查询集合。
	SupportedFeatures	ID列表所有已知支持的功能。
	TreeViolationException	为工作项类型的导入过程中，生成的错误类别。
	UnexpectedErrorException	报告异常的错误条件的选件类。
	UnsupportedDocumentVersionException	不支持的选件类文档版本错误。
	ValidationException	类别描述验证异常。
	ValuesCollection	值的集合。
	VerbatimMessageException	为具有是否应演示原义的错误类别。
	WorkItem	表示在 Team Foundation Server的工作项。
	WorkItemAsyncEventArgs	处理工作项异步更改事件的选件类对查询的状态。
	WorkItemChangeRejectedException	工作项更改拒绝错误的选件类。
	WorkItemCollection	表示的工作项的集合由查询添加到 WorkItemStore。
	WorkItemEventArgs	工作项的事件的参数。
	WorkItemFieldData
	WorkItemLink	链接两在同一 WorkItemStore的 WorkItem的。
	WorkItemLinkCollection	表示 WorkItemLinks. 的集合。
	WorkItemLinkData
	WorkItemLinkEventArgs	工作项链接的事件的参数。
	WorkItemLinkType	表示 WorkItemLink的特定类型。
	WorkItemLinkTypeCollection	表示 WorkItemLinkType 对象的集合。
	WorkItemLinkTypeEnd	表示 WorkItemLinkType的终点。
	WorkItemLinkTypeEndCollection	表示 WorkItemLinkTypeEnd 对象的集合。
	WorkItemLinkValidationException	为工作项链接的验证期间发生的错误类别。
	WorkItemOperationError	表示操作的错误在工作项。
	WorkItemStore	表示跟踪与运行 Team Foundation Server的服务器的工作项客户端连接。
	WorkItemStoreDiagnostics	执行工作项链接服务的诊断方法。
	WorkItemSyncData
	WorkItemType	表示 WorkItem的特定类型。
	WorkItemTypeCollection	表示 WorkItemType 对象的集合。
	WorkItemTypeDeniedOrNotExistException	类别描述访问被拒绝否则工作项类型不存在异常。

结构

	结构	说明
	FieldIndexData	域的索引数据的数据结构。
	WorkItem.EditActionInfo
	WorkItem.EditActionSet
	WorkItemFieldData.FieldInfo
	WorkItemFieldData.FieldUpdate
	WorkItemLinkInfo	表示 WorkItemLink 查询的结构发生。
	WorkItemLinkValidationException.WorkItemLinkInfo	描述工作项链接信息。

委托

	委托	说明
	ImportEventHandler	导入的事件处理程序。
	MetadataChangeEventHandler	元数据更改事件处理程序。
	QueryFolderContentsChangedEventHandler	ContentsChanged 和 ChangesCommitted 事件的事件处理程序委托。
	StoredQueriesEventHandler	存储查询的事件处理程序。
	WorkItemAsyncEventHandler	此事件处理程序侦听对查询的状态的异步更改。
	WorkItemFieldChangeEventHandler	将激发的事件的事件处理程序委托，在更改的字段。
	WorkItemPreSaveEventHandler

枚举

	枚举	说明
	BaseLinkType	描述链接类型。
	CancelableActionState	描述一个取消的事件的状态。
	CoreField	指定 WorkItem 字段的类型。
	FieldStatus	描述字段的状态。
	FieldType	描述 Field的数据类型。
	FieldUsages	描述 FieldDefinition 将对象的类型。
	ImportSeverity	描述操作的严重级别。
	ImportStructureException.Type	描述异常的类型。
	ImportWorkItemLinkTypeException.Type	进一步指定 WorkItemLinkTypeException 的类型。
	ImportWorkitemTypeException.Type	WorkitemType异常的进一步类别。
	LinkAction	描述如何修改集合。
	MetadataChangeTypes	描述所有可能的元数据更改。
	Node.TreeType	描述树的类型 (区域或迭代)。
	PageSizes	描述用于查询支持，并且批读取的页大小。
	QueryFolderAction	指示发生了在文件夹中的项更改的类型。
	QueryHierarchyException.Type	进一步分类 QueryHierarchyException。
	QueryItemPermissions	查询项目的权限位掩码。
	QueryScope	描述查询范围。
	QueryType	描述查询的类型。
	ReportingType	描述字段的报告类型。
	SaveFlags	描述保存标志。
	SchemaType	描述XML架构的文档。
	SortType	描述 SortField 的排序顺序。
	StoredQueriesAction	描述中存储的查询集合执行的最新事件。
	StringDataLengths	描述可以保存到数据库的字符串值的最大长度。
	TargetSet	指定目标链接集合。
	UserDisplayMode	指定用户帐户的显示模式。
	WorkItem.EditAction
	WorkItem.EditActionFlags
	WorkItemCopyFlags	指定选项工作项数据应复制的标志。
	WorkItemFieldData.FieldFlags
	WorkItemLinkType.Topology	描述 WorkItemLinkType允许的拓扑类型。
	WorkItemLinkValidationException.Action	描述异常的事件。
	WorkItemLinkValidationException.Type	描述异常的类型。
	WorkItemStoreFlags	枚举用于定位工作项存储对象行为

请参见

参考

其他资源

扩展 Team Foundation