Field Class

Represents a field in a WorkItem.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.WorkItemTracking.Client.Field

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

'Declaration
Public NotInheritable Class Field

public sealed class Field

public ref class Field sealed

[<Sealed>]
type Field =  class end

public final class Field

The Field type exposes the following members.

	Name	Description
	AllowedValues	Gets a collection of values that are valid for this field.
	FieldDefinition	Gets the FieldDefinition that defines this field.
	HasAllowedValuesList	Gets a flag that indicates whether a list of allowed values is available for this field.
	HasPatternMatch	Gets a flag that indicates whether the value of this field must match a pattern.
	Id	Gets the ID of this field.
	IsChangedByUser
	IsComputed	Gets a flag that indicates whether the value of this field is computed from the values of other fields.
	IsDirty	Gets a flag that indicates whether the value of this field has unsaved changes.
	IsEditable	Gets a flag that indicates whether the value of this field can be edited in the current state of the work item.
	IsLimitedToAllowedValues	Gets a flag that indicates whether this field is restricted to a collection of allowed values.
	IsRequired	Gets a flag that indicates whether this field requires a value.
	IsValid	Gets a flag that indicates whether the value of the field is valid based on rules.
	Name	Gets the name of this field.
	OriginalValue	Gets the value of this field as it existed when the work item was saved most recently.
	ProhibitedValues	Gets the list of values that are not allowed for this field.
	ReferenceName	Gets the reference name of this field.
	Status	Gets a description of the current state of this field.
	Value	Gets or sets the current value of this field.
	WorkItem	Gets the WorkItem that contains this field.

Top

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

A field is the data container in a WorkItem. Each field in a WorkItem has a unique ID number.

You define the rules that govern a field (for example, computer values or pattern matching) in the WorkItemType.

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