FieldDefinition Class

Represents the attributes of a Field.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.WorkItemTracking.Client.FieldDefinition

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

Syntax

'Declaration
Public Class FieldDefinition
public class FieldDefinition
public ref class FieldDefinition
type FieldDefinition =  class end
public class FieldDefinition

The FieldDefinition type exposes the following members.

Properties

Name Description
Public property AllowedValues Gets the collection of valid values for a Field that uses this field definition.
Public property CanSortBy Gets the flag that describes whether WorkItems can be sorted by Fields that use this field definition.
Public property FieldType Gets the data type that is stored by a Field that uses this field definition.
Public property HelpText Gets the text that describes this field definition.
Public property Id Gets the ID of this field definition.
Public property IsComputed Gets a flag that describes whether the value of the Field that uses this field definition is computed.
Public property IsCoreField Returns whether a field is indexed.
Public property IsEditable Gets a flag that describes whether a Field that uses this field definition is editable.
Public property IsIndexed Gets a flag that describes whether a Field that uses this field definition is indexed on the server.
Public property IsQueryable Gets a flag that describes whether work items can be queried by a Field that uses this field definition.
Public property Name Gets the friendly display name of this field definition.
Public property ReferenceName Gets the reference name of this field definition.
Public property ReportingAttributes Gets the reporting attributes of this field definition.
Public property SystemType Gets the underlying Type of this field definition.
Public property Usage Gets the intended usage of this field definition.

Top

Methods

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method FilteredAllowedValues Gets the collection of allowed values for a Field that uses this field definition, which is filtered by the specified list of filters.
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 the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

The FieldDefinition object defines the data that a WorkItemField contains.

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.

See Also

Reference

Microsoft.TeamFoundation.WorkItemTracking.Client Namespace