This documentation is archived and is not being maintained.

CheckinNoteFieldDefinition Class

A field definition is used to define how a given named input is treated when it is applied to a given checkin note. These are not versioned and can change over time, which allows the definition and the data to become out of sync with each other. The definition is used at the time the check-in note is generated.


Namespace:  Microsoft.TeamFoundation.VersionControl.Server
Assembly:  Microsoft.TeamFoundation.VersionControl.Server (in Microsoft.TeamFoundation.VersionControl.Server.dll)

public class CheckinNoteFieldDefinition

The CheckinNoteFieldDefinition type exposes the following members.

Public propertyDisplayOrderThe displayOrder property is used to give the client a hint in how an input or output form will be displayed. These are guidelines and are not fixed given a checkin not instance can have cross definition values.
Public propertyNameThis is the name of the field.
Public propertyRequiredRequired tells the client whether the value can be left empty or a value must be supplied.
Public propertyServerItemThis is the version control server item the field is associated with.

Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
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 the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToString (Overrides Object.ToString().)

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