Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

WorkItemStore Class

Represents the Work Item Tracking client connection to a server that is running Team Foundation Server.

System.Object
  Microsoft.TeamFoundation.WorkItemTracking.Client.WorkItemStore

Namespace:  Microsoft.TeamFoundation.WorkItemTracking.Client
Assembly:  Microsoft.TeamFoundation.WorkItemTracking.Client (in Microsoft.TeamFoundation.WorkItemTracking.Client.dll)
public sealed class WorkItemStore

The WorkItemStore type exposes the following members.

  NameDescription
Public methodWorkItemStore(String)Initializes a new instance of the WorkItemStore class that is connected to the server that is running Team Foundation Server that is specified by the computer name.
Public methodWorkItemStore(TeamFoundationServer) Obsolete. Initializes a new instance of the WorkItemStore class that is connected to the specified TeamFoundationServer instance.
Public methodWorkItemStore(TfsTeamProjectCollection)Initializes a new instance of the WorkItemStore class that is connected to the specified TfsTeamProjectCollection instance.
Top
  NameDescription
Public propertyCallingProcessIdentity Obsolete. Gets or sets the string that identifies the calling process to the server.
Public propertyCultureInfoGets the localization environment that is used by the client.
Public propertyDiagnosticsGets the diagnostics object that is associated with this server connection.
Public propertyFieldDefinitionsGets the collection of field definitions that are associated with this WorkItemStore instance.
Public propertyProjectsGets the collection of Projects that is associated with this WorkItemStore instance.
Public propertyRegisteredLinkTypesGets the cached RegisteredLinkTypeCollection that is associated with this server.
Public propertyServerInfoGets the server information object that contains all features that are supported by the server.
Public propertyTeamFoundationServer Obsolete. Gets the connection to the server that is running Team Foundation Server.
Public propertyTeamProjectCollectionGets the connection to the server that is running Team Foundation Server.
Public propertyTimeZoneGets the time zone of the client.
Public propertyUserDisplayModeGets the mode in which user account information is displayed for this work item store.
Public propertyWorkItemLinkTypesGets the cached WorkItemLinkTypeCollection that is associated with the server.
Top
  NameDescription
Public methodBatchSave(WorkItem[])Commits multiple items in a branch and returns a list of errors if one or more items fail.
Public methodBatchSave(WorkItem[], SaveFlags)Commits multiple items in a branch and returns a list of errors if one or more items fail.
Public methodDestroyWorkItemsDestroys work items that have the specified IDs.
Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodExportGlobalListsExports all data that is stored in the database global lists to an XmlDocument.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetQueryDefinitionGets a query definition that is identified by the specified GUID.
Public methodGetReferencingWorkItemUrisGets an array of work item uniform resource identifiers (URIs) that point to the specified work item.
Public methodGetStoredQuery Obsolete. Gets a stored query by GUID.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetWorkItem(Int32)Gets the work item that has the specified ID.
Public methodGetWorkItem(Uri)Gets the work item at the specified URI.
Public methodGetWorkItem(Int32, DateTime)Gets the previous state of a work item that is specified by ID and date.
Public methodGetWorkItem(Int32, Int32)Gets the previous state of a work item that is specified by ID and revision number.
Public methodGetWorkItem(Uri, DateTime)Gets the work item state from a specific time for viewing.
Public methodGetWorkItem(Uri, Int32)Gets the work item state from a specific revision for viewing.
Public methodGetWorkItemIdsForArtifactUrisA list of artifact links that are paired with their referencing work items.
Public methodImportGlobalLists(String)Imports specified global lists (in XML format) into the database.
Public methodImportGlobalLists(XmlElement)Imports global lists into the database.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodQuery(String)Executes the query that is described in wiql and returns a collection of work items.
Public methodQuery(Int32[], String)Gets the set of fields that is referred to in wiql for the work items that are specified by an ID number (ids)..
Public methodQuery(String, IDictionary)Executes the query that is described in wiql and the parameters that are described in context.
Public methodQuery(BatchReadParameterCollection, String)Gets the set of fields that is referred to in Wiql for the work items that are specified by the ID/revision pairs in batchReadParams.
Public methodQuery(Int32[], Int32[], String)Gets the set of fields that is referred to in wiql for the work items that are specified by an ID number, ids, and revision (revs).
Public methodQuery(Int32[], String, DateTime)Gets the set of fields that is referred to in wiql for the work items that are specified by an ID number (ids) as of the date that is specified in asof.
Public methodQueryCount(String)Gets the number of items that would be returned if the query was executed.
Public methodQueryCount(String, IDictionary)Gets the number of items that would be returned if the query was executed.
Public methodRefreshCacheCalls the back end to refresh cached metadata.
Public methodSyncToCacheSync to the last version of the cache.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Public eventImportEventHandlerAn event that occurs during ImportGlobalLists call.
Public eventMetadataChangedAn event that occurs when metadata is changed after the change is processed by the object model.
Public eventMetadataChanging Obsolete. An event that occurs when metadata is changed before the change is processed by the object model.
Top
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.