WorkItem Members

Include Protected Members
Include Inherited Members

This class encapsulates a work item instance.

The WorkItem type exposes the following members.

Constructors

 

Name

Description

Public method

WorkItem

Initializes a blank work item of a specific WorkItemType.

Top

Methods

 

Name

Description

Public method

Copy

Overloaded.

Public method

Equals

Determines whether the specified Object is equal to the current Object. (Inherited from Object.)

Protected method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

Public method

GetHashCode

Serves as a hash function for a particular type. (Inherited from Object.)

Public method

GetNextState

Returns the next state per the action string.

Public method

GetType

Gets the type of the current instance. (Inherited from Object.)

Public method

IsValid

true if this WorkItem is valid (all Fields, Links, and Attachments in this work item are valid); otherwise false.

Protected method

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Public method

Open

Opens this WorkItem for editing.

Public method

PartialOpen

Opens this WorkItem for editing without transferring all the data about the work item over the wire.

Public method

Reset

Reverts all changes that were made to this WorkItem since the last revision.

Public method

Save

Saves this WorkItem after validating its contents.

Public method

SyncToLatest

Updates this WorkItem to the latest committed revision. All changes that were made to the work item from the last revision will be discarded.

Public method

ToString

Returns a string that represents the current object. (Inherited from Object.)

Public method

Validate

Validates the field values for this WorkItem against the rules that are defined for the work item type.

Top

Properties

 

Name

Description

Public property

AreaId

Gets or sets the Area ID.

Public property

AreaPath

Gets or sets the Area Path.

Public property

AttachedFileCount

Gets the count of attached files.

Public property

Attachments

Gets collection of attachments associated with this work item.

Public property

ChangedBy

Gets the name of the one who changed this work item.

Public property

ChangedDate

Gets the date of this change.

Public property

CreatedBy

Gets the name of the one who created this work item.

Public property

CreatedDate

Gets the date this work item was created.

Public property

Description

Gets the description of this work item.

Public property

DisplayForm

Gets the form associated with this WorkItem.

Public property

ExternalLinkCount

Gets the count of external links.

Public property

Fields

Gets the collection of fields referenced by this work item.

Public property

History

Gets or sets the history of this work item.

Public property

HyperLinkCount

Gets the count of hyperlinks.

Public property

Id

Gets the ID of this work item. Returns zero for a new, unsaved item.

Public property

IsDirty

true if this work item has been edited in any way, including field or collection changes; otherwise false.

Public property

IsOpen

true if this work item is opened for editing; otherwise false.

Public property

IsPartialOpen

true if the item is open for "partial" edit; otherwise false.

Public property

IsReadOnlyOpen

true if the item is open read-only; otherwise false.

Public property

Item

Overloaded. Gets or sets the value of a field in this WorkItem by field name. The name passed in can be a field name, or a reference name.

Public property

IterationId

Gets or sets the iteration ID.

Public property

IterationPath

Gets or sets the iteration path.

Public property

Links

Gets the collection of outgoing links for this WorkItem.

Public property

NodeName

Gets the node name for the work item.

Public property

Project

Gets the team project to which this work item belongs.

Public property

Reason

Gets or sets the reason field for this work item.

Public property

RelatedLinkCount

Gets the count of related links to this work item.

Public property

Rev

Gets the revision of this work item.

Public property

RevisedDate

Gets the revision date of this work item.

Public property

Revision

Gets current revision of this WorkItem.

Public property

Revisions

Gets the collection of previous revisions to this WorkItem.

Public property

State

Gets the state of this work item.

Public property

Store

Gets the WorkItemStore to which this WorkItem belongs.

Public property

Title

Gets the title of this work item.

Public property

Type

Gets the WorkItemType for the current WorkItem.

Public property

Uri

Gets the Uri of the current WorkItem.

Top

Events

 

Name

Description

Public event

FieldChanged

Occurs every time a field is updated.

Top

See Also

Reference

WorkItem Class

Microsoft.TeamFoundation.WorkItemTracking.Client Namespace