WorkItemStore Class

Article
11/19/2013

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

Inheritance Hierarchy

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

Namespace: Microsoft.TeamFoundation.WorkItemTracking.Client
Assembly: Microsoft.TeamFoundation.WorkItemTracking.Client (in Microsoft.TeamFoundation.WorkItemTracking.Client.dll)

Syntax

'Declaration
Public NotInheritable Class WorkItemStore

public sealed class WorkItemStore

public ref class WorkItemStore sealed

[<Sealed>]
type WorkItemStore =  class end

public final class WorkItemStore

The WorkItemStore type exposes the following members.

Constructors

	Name	Description
	WorkItemStore(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.
	WorkItemStore(TeamFoundationServer)	Obsolete. Initializes a new instance of the WorkItemStore class that is connected to the specified TeamFoundationServer instance.
	WorkItemStore(TfsTeamProjectCollection)	Initializes a new instance of the WorkItemStore class that is connected to the specified TfsTeamProjectCollection instance.
	WorkItemStore(String, WorkItemStoreFlags)
	WorkItemStore(TfsTeamProjectCollection, WorkItemStoreFlags)

Top

Properties

	Name	Description
	BypassRules	Gets/sets whether the work item store object bypass rules
	CallingProcessIdentity	Obsolete. Gets or sets the string that identifies the calling process to the server.
	CultureInfo	Gets the localization environment that is used by the client.
	Diagnostics	Gets the diagnostics object that is associated with this server connection.
	FieldDefinitions	Gets the collection of field definitions that are associated with this WorkItemStore instance.
	MaxBulkUpdateBatchSize
	Projects	Gets the collection of Projects that is associated with this WorkItemStore instance.
	RegisteredLinkTypes	Gets the cached RegisteredLinkTypeCollection that is associated with this server.
	ServerInfo	Gets the server information object that contains all features that are supported by the server.
	TeamFoundationServer	Obsolete. Gets the connection to the server that is running Team Foundation Server.
	TeamProjectCollection	Gets the connection to the server that is running Team Foundation Server.
	TimeZone	Gets the time zone of the client.
	UserDisplayMode	Gets the mode in which user account information is displayed for this work item store.
	WorkItemLinkTypes	Gets the cached WorkItemLinkTypeCollection that is associated with the server.

Top

Methods

	Name	Description
	BatchSave(array<WorkItem[])	Commits multiple items in a branch and returns a list of errors if one or more items fail.
	BatchSave(array<WorkItem[], SaveFlags)	Commits multiple items in a branch and returns a list of errors if one or more items fail.
	DestroyWorkItems	Destroys work items that have the specified IDs.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExportGlobalLists	Exports all data that is stored in the database global lists to an XmlDocument.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetQueryDefinition	Gets a query definition that is identified by the specified GUID.
	GetReferencingWorkItemUris	Gets an array of work item uniform resource identifiers (URIs) that point to the specified work item.
	GetStoredQuery	Obsolete. Gets a stored query by GUID.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWorkItem(Int32)	Gets the work item that has the specified ID.
	GetWorkItem(Uri)	Gets the work item at the specified URI.
	GetWorkItem(Int32, DateTime)	Gets the previous state of a work item that is specified by ID and date.
	GetWorkItem(Int32, Int32)	Gets the previous state of a work item that is specified by ID and revision number.
	GetWorkItem(Uri, DateTime)	Gets the work item state from a specific time for viewing.
	GetWorkItem(Uri, Int32)	Gets the work item state from a specific revision for viewing.
	GetWorkItemIdsForArtifactUris	A list of artifact links that are paired with their referencing work items.
	ImportGlobalLists(String)	Imports specified global lists (in XML format) into the database.
	ImportGlobalLists(XmlElement)	Imports global lists into the database.
	Query(String)	Executes the query that is described in wiql and returns a collection of work items.
	Query(array<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)..
	Query(String, IDictionary)	Executes the query that is described in wiql and the parameters that are described in context.
	Query(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.
	Query(array<Int32[], array<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).
	Query(array<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.
	QueryCount(String)	Gets the number of items that would be returned if the query was executed.
	QueryCount(String, IDictionary)	Gets the number of items that would be returned if the query was executed.
	RefreshCache()	Calls the back end to refresh cached metadata.
	RefreshCache(Boolean)
	SyncToCache	Sync to the last version of the cache.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	ImportEventHandler	An event that occurs during ImportGlobalLists call.
	MetadataChanged	An event that occurs when metadata is changed after the change is processed by the object model.
	MetadataChanging	Obsolete. An event that occurs when metadata is changed before the change is processed by the object model.

Top

Remarks

For more information about how to use this type, see Create a Work Item By Using the Client Object Model for Team Foundation.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via