This documentation is archived and is not being maintained.

Microsoft.TeamFoundation.WorkItemTracking.Client Namespace

The TeamFoundation.WorkItemTracking.Client namespace provides the APIs that are required to enable a client computer or application to work with user stories, requirements, tasks, bugs, and other types of work items.

The WorkItemStore represents the connection to the repository of work items on Visual Studio Team Foundation Server. The WorkItem object contains Fields that store data, Attachments that represent files, and WorkItemLinks that connect to other work items. The following example code demonstrates how to access a “User Story” work item type on a work item store.

// 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"];

The Query class represents a query to the WorkItemStore. An executed query returns a WorkItemCollection, which contains the work items that satisfy the query.

The WorkItemType class defines a work item. The FieldDefinition class defines a field in a work item. The WorkItemLinkType class defines a WorkItemLink, which links two work items.

You can find the Microsoft.TeamFoundation.WorkItemTracking.Client namespace in \Program Files\Microsoft Visual Studio 10.0\Common7\IDE\ReferenceAssemblies\v2.0 on computers where Team Explorer is installed, in the following assembly:

  • Microsoft.TeamFoundation.WorkItemTracking.Client.dll

Public classAdministrationClass for administrative tasks to perform on a work item store.
Public classAllowedValuesCollectionRepresents a list of valid values for a Field.
Public classAttachmentDescribes a file attachment to a work item.
Public classAttachmentCollectionStores the attachments that are associated with a work item.
Public classBatchReadParameterRepresents an ID and revision pair that will be added to a BatchReadParameterCollection.
Public classBatchReadParameterCollectionRepresents a collection of parameters from a batch read.
Public classBatchSaveRepresents methods and properties for batch saving work item links.
Public classBatchSaveErrorClass to describe a batch save error for a single work item.
Public classBatchSaveFailedExceptionClass for a batch save failed error.
Public classBatchSaveRetryFailedExceptionClass for an error that occurs during a retry of a batch save.
Public classCancelableAsyncResultClass that is used to access the state of the asynchronous operation or to cancel the result.
Public classCannotChangePageSizeException Obsolete. Class for an attempt to change page size error.
Public classCategoryDescribes the category of work item types.
Public classCategoryCollectionA collection of category objects.
Public classClientExceptionBase class for all client-generated exceptions.
Public classConnectionExceptionClass to describe a connection failure to the server.
Public classCoreFieldReferenceNamesClass that contains the reference names for core fields.
Public classCoreLinkTypeReferenceNamesClass that contains reference names for core link types.
Public classDeniedOrNotExistExceptionClass to describe access denied or item does not exist exceptions.
Public classDisplayFieldListRepresents a collection of WorkItem FieldDefinitions that will be paged from the server when the WorkItems in a WorkItemCollection are accessed.
Public classDuplicateBatchReadParameterExceptionClass for a duplicate batch read parameter error.
Public classDuplicateWorkItemException Obsolete. Class for a duplicate work item error.
Public classExternalLinkRepresents a link to other tools.
Public classFieldRepresents a field in a WorkItem.
Public classFieldCollectionRepresents a collection of Fields in a WorkItem object.
Public classFieldConflict
Public classFieldDefinitionRepresents the attributes of a Field.
Public classFieldDefinitionCollectionDescribes a collection of FieldDefinition objects.
Public classFieldDefinitionNotExistExceptionClass for an error when a field definition does not exist.
Public classFieldFilterRepresents a single field-value pair that can be used to model a FieldDefinition object. Used together with a FieldFilterList to filter allowed values of fields.
Public classFieldFilterListRepresents a list of field filters that can be sorted by using a query.
Public classFileAttachmentExceptionClass for a file attachment error.
Public classHyperlinkRepresents a hyperlink. The link type is URL, UNC, or BIS URI.
Public classIdentityNotExistExceptionClass for an error when an identity does not exist in a collection.
Public classImportEventArgsArguments for import events.
Public classImportStructureExceptionClass for an error that occurs during import of a work item type.
Public classImportWorkItemLinkTypeExceptionClass for a query text error that is not valid.
Public classImportWorkitemTypeExceptionClass for an error that occurs during import of a work item type.
Public classInternalDatastoreExceptionException for an error in the internal data store.
Public classInternalFieldsDefines all internal field reference names.
Public classInvalidFieldValueExceptionClass for an error that occurs when an attempt is made to write an invalid value to a field.
Public classInvalidProjectException Obsolete. Class for an invalid project error.
Public classInvalidQueryTextExceptionClass for a query text error that is not valid.
Public classInvalidTreeNodeExceptionClass for an invalid tree node error.
Public classItemAlreadyUpdatedOnServerExceptionClass for an item already updated on server error.
Public classLinkDescribes the implementation of a link.
Public classLinkCollectionRepresents the collection of Link objects that belongs to a WorkItem.
Public classMetadataEventArgsArguments for metadata change events.
Public classNodeDescribes a Node object that is used in the work item tracking data structures.
Public classNodeCollectionRepresents a collection of Node objects.
Public classPageSizeRangeExceptionClass for an error in the page size range.
Public classProjectRepresents a work item tracking project.
Public classProjectCollectionRepresents a collection of projects.
Public classQueryRepresents a query to the work item tracking service.
Public classQueryDefinitionRepresents a query.
Public classQueryFolderRepresents a folder in a team project that can contain QueryDefinitions and other QueryFolders.
Public classQueryFolderContentsChangedEventArgsEvent arguments for the QueryFolderContentsChanged event.
Public classQueryHierarchyRepresents the top-level folder in a project.
Public classQueryHierarchyExceptionClass for an error that occurs during a query of the hierarchy of the work item store.
Public classQueryItemThe base class for query folders and query definitions.
Public classReadOnlyFieldExceptionClass for an attempt to write to a read-only field error.
Public classRegisteredLinkTypeDescribes a registered link type.
Public classRegisteredLinkTypeCollectionA collection of valid registered link types.
Public classRelatedLinkLinks two work item objects in the same work item store and across stores.
Public classReportingAttributesDescribes the reporting attributes of the field.
Public classRequestCancelledByUserExceptionClass for a request cancelled by user error.
Public classRequestNotCancelableExceptionClass for an attempt to cancel a noncancelable request error.
Public classRevisionRepresents a work item revision state.
Public classRevisionCollectionRepresents the revision history of a work item.
Public classSchemasAbstract class that contains schema-related methods.
Public classServerClass used to make server calls.
Public classServerInfoThis class exposes information about the server.
Public classServerRejectedChangesExceptionClass for a server rejected changes error.
Public classSortFieldRepresents a WorkItem Field that can be used to sort the results of a query.
Public classSortFieldListRepresents a collection of SortFields that can be sorted by a query.
Public classStoredQueriesChangedEventArgsArguments or the StoredQueriesChanged event.
Public classStoredQueryRepresents a stored query.
Public classStoredQueryCollectionRepresents the stored queries collection from a project or work item store.
Public classSupportedFeaturesA list of IDs for all known supported features.
Public classTreeViolationExceptionClass for an error that occurs during import of a work item type.
Public classUnexpectedErrorExceptionA class to report unusual error conditions.
Public classUnsupportedDocumentVersionExceptionClass for unsupported document version errors.
Public classValidationExceptionClass to describe validation exceptions.
Public classValuesCollectionA collection of values.
Public classVerbatimMessageExceptionClass for an error that has a message that should be displayed verbatim.
Public classWorkItemRepresents a work item on Team Foundation Server.
Public classWorkItemAsyncEventArgsA class to handle WorkItem asynchronous change events to the state of a query.
Public classWorkItemChangeRejectedExceptionClass for a work item change rejection error.
Public classWorkItemCollectionRepresents a collection of work items that result from a query to the WorkItemStore.
Public classWorkItemEventArgsArguments for a work item event.
Public classWorkItemLinkLinks two WorkItems in the same WorkItemStore.
Public classWorkItemLinkCollectionRepresents a collection of WorkItemLinks.
Public classWorkItemLinkEventArgsArguments for a work item link event.
Public classWorkItemLinkTypeRepresents a specific type of WorkItemLink.
Public classWorkItemLinkTypeCollectionRepresents a collection of WorkItemLinkType objects.
Public classWorkItemLinkTypeEndRepresents an endpoint of a WorkItemLinkType.
Public classWorkItemLinkTypeEndCollectionRepresents a collection of WorkItemLinkTypeEnd objects.
Public classWorkItemLinkValidationExceptionClass for an error that occurs during validation of a work item link.
Public classWorkItemOperationErrorRepresents the error of an operation on a work item.
Public classWorkItemStoreRepresents the Work Item Tracking client connection to a server that is running Team Foundation Server.
Public classWorkItemStoreDiagnosticsImplements diagnostic methods for the work item link service.
Public classWorkItemTypeRepresents a specific type of WorkItem.
Public classWorkItemTypeCollectionRepresents a collection of WorkItemType objects.
Public classWorkItemTypeDeniedOrNotExistExceptionClass to describe access denied or work item type does not exist exceptions.

Public structureFieldIndexDataData structure for field index data.
Public structureWorkItem.EditActionInfo
Public structureWorkItem.EditActionSet
Public structureWorkItemLinkInfoStructure that represents WorkItemLink query results.
Public structureWorkItemLinkValidationException.WorkItemLinkInfoDescribes the work item link information.

Public delegateImportEventHandlerEvent handler for an import.
Public delegateMetadataChangeEventHandlerEvent handler for metadata changes.
Public delegateQueryFolderContentsChangedEventHandlerEvent handler delegate for the ContentsChanged and ChangesCommitted event.
Public delegateStoredQueriesEventHandlerThe event handler for stored queries.
Public delegateWorkItemAsyncEventHandlerThis event handler listens to asynchronous changes to the state of a query.
Public delegateWorkItemFieldChangeEventHandlerEvent handler delegate for events that are fired when a field is changed.
Public delegateWorkItemPreSaveEventHandler

Public enumerationBaseLinkTypeDescribes the type of a link.
Public enumerationCancelableActionStateDescribes the state of a cancellable action.
Public enumerationCoreFieldSpecifies the type of a WorkItem field.
Public enumerationFieldStatusDescribes status of a field.
Public enumerationFieldTypeDescribes the data type of a Field.
Public enumerationFieldUsagesDescribes the type of object on which a FieldDefinition applies.
Public enumerationImportSeverityDescribes the severity of an event.
Public enumerationImportStructureException.TypeDescribes the type of the exception.
Public enumerationImportWorkItemLinkTypeException.TypeFurther specifies the type of a WorkItemLinkTypeException.
Public enumerationImportWorkitemTypeException.TypeFurther classification of the WorkitemType exception.
Public enumerationLinkActionDescribes how the collection was modified.
Public enumerationMetadataChangeTypesDescribes all possible metadata change types.
Public enumerationNode.TreeTypeDescribes the type of tree (area or iteration).
Public enumerationPageSizesDescribes the page sizes that are supported for queries and batch reads.
Public enumerationQueryFolderActionIndicates the type of changes that occurred to an item in a folder.
Public enumerationQueryHierarchyException.TypeFurther classifies a QueryHierarchyException.
Public enumerationQueryItemPermissionsPermissions bit masks for query items.
Public enumerationQueryScopeDescribes the query scope.
Public enumerationQueryTypeDescribes the type of the query.
Public enumerationReportingTypeDescribes the reporting type of the field.
Public enumerationSaveFlagsDescribes the save flags.
Public enumerationSchemaTypeDescribes the schema of an XML document.
Public enumerationSortTypeDescribes the order by which a SortField is sorted.
Public enumerationStoredQueriesActionDescribes the latest action that was performed on a stored queries collection.
Public enumerationStringDataLengthsDescribes the maximum lengths for string values that may be saved to the database.
Public enumerationTargetSetSpecifies the target link collection.
Public enumerationUserDisplayModeSpecifies the display mode of the user account.
Public enumerationWorkItem.EditAction
Public enumerationWorkItem.EditActionFlags
Public enumerationWorkItemCopyFlagsFlags that specify optional work item data that should be copied.
Public enumerationWorkItemLinkType.TopologyDescribes the allowed Topology types for WorkItemLinkType.
Public enumerationWorkItemLinkValidationException.ActionDescribes the action of the exception.
Public enumerationWorkItemLinkValidationException.TypeDescribes the type of the exception.
Public enumerationWorkItemStoreFlagsEnum used to determine behavior of work item store object


Other Resources