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 checkin note is generated

Inheritance Hierarchy


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


Public Class CheckinNoteFieldDefinition
public class CheckinNoteFieldDefinition
public ref class CheckinNoteFieldDefinition
type CheckinNoteFieldDefinition =  class end
public class CheckinNoteFieldDefinition

The CheckinNoteFieldDefinition type exposes the following members.


  Name Description
Public method CheckinNoteFieldDefinition



  Name Description
Public property DisplayOrder The 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 property Name This is the name of the field.
Public property Required Required tells the client whether the value can be left empty or a value must be supplied.
Public property ServerItem This is the version control server item the field is associated with



  Name Description
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 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 (Overrides Object.ToString().)


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


Microsoft.TeamFoundation.VersionControl.Server Namespace