Export (0) Print
Expand All

WorkItemType Class

Represents a specific type of WorkItem.

System.Object
  Microsoft.TeamFoundation.WorkItemTracking.Client.WorkItemType

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

public sealed class WorkItemType

The WorkItemType type exposes the following members.

  NameDescription
Public propertyDescriptionGets a user-readable description of this work item type.
Public propertyDisplayFormGets the URL of the display form for this work item type.
Public propertyFieldDefinitionsGets the collection of FieldDefinitions that belongs to this work item type.
Public propertyNameGets the name of this work item type.
Public propertyProjectGets the Project to which this work item type belongs.
Public propertyStoreGets the WorkItemStore that contains this work item type.
Top

  NameDescription
Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodExportExports the work item type definition to XML.
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 methodGetNextStateGets the next state of this work item type based on the current state and the specified action.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodNewWorkItemCreates and returns a new WorkItem instance of this work item type.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodStatic memberValidate(Project, String)Validates this work item type in the context of the specified Project.
Public methodStatic memberValidate(WorkItemStore, String)Validates the work item type in the context of the specified WorkItemStore.
Public methodStatic memberValidate(Project, String, String)Validates the work item type in the context of the given Project and development method.
Public methodStatic memberValidate(WorkItemStore, String, String)Validates the work item type in the context of the specified WorkItemStore.
Top

  NameDescription
Public eventStatic memberValidationEventHandlerEvent handler for events that occur during the Validate call.
Top

More detail on work item types can be found in Customizing Project Tracking Data, Forms, Workflow, and Other Objects. The XML schema for a work item type is described in Index to XML Element Definitions for Types of Work Items.

Each WorkItem contains a reference to the WorkItemType that it implements. You must specify a WorkItemType when you construct a WorkItem through: WorkItem.WorkItem(WorkItemType). You can get the WorkItemType of a WorkItem through the WorkItem.Type property.

You can determine the rules that govern the fields of this work item type by exporting the work item type definition to XML and parsing the XML.

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

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

Community Additions

ADD
Show:
© 2014 Microsoft