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 | |
---|---|---|
AllowedValues | Gets the collection of valid values for a Field that uses this field definition. | |
CanSortBy | Gets the flag that describes whether WorkItems can be sorted by Fields that use this field definition. | |
FieldType | Gets the data type that is stored by a Field that uses this field definition. | |
HelpText | Gets the text that describes this field definition. | |
Id | Gets the ID of this field definition. | |
IsComputed | Gets a flag that describes whether the value of the Field that uses this field definition is computed. | |
IsCoreField | Returns whether a field is indexed. | |
IsEditable | Gets a flag that describes whether a Field that uses this field definition is editable. | |
IsIndexed | Gets a flag that describes whether a Field that uses this field definition is indexed on the server. | |
IsQueryable | Gets a flag that describes whether work items can be queried by a Field that uses this field definition. | |
Name | Gets the friendly display name of this field definition. | |
ReferenceName | Gets the reference name of this field definition. | |
ReportingAttributes | Gets the reporting attributes of this field definition. | |
SystemType | Gets the underlying Type of this field definition. | |
Usage | Gets the intended usage of this field definition. |
Top
Methods
Name | Description | |
---|---|---|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
FilteredAllowedValues | Gets the collection of allowed values for a Field that uses this field definition, which is filtered by the specified list of filters. | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
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.