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.
Inheritance Hierarchy
System.Object
Microsoft.TeamFoundation.VersionControl.Server.CheckinNoteFieldDefinition
Namespace: Microsoft.TeamFoundation.VersionControl.Server
Assembly: Microsoft.TeamFoundation.VersionControl.Server (in Microsoft.TeamFoundation.VersionControl.Server.dll)
Syntax
'Declaration
Public Class CheckinNoteFieldDefinition
public class CheckinNoteFieldDefinition
public ref class CheckinNoteFieldDefinition
type CheckinNoteFieldDefinition = class end
public class CheckinNoteFieldDefinition
The CheckinNoteFieldDefinition type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
CheckinNoteFieldDefinition |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "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. |
|
Name | This is the name of the field. |
|
Required | Required tells the client whether the value can be left empty or a value must be supplied. |
|
ServerItem | This is the version control server item the field is associated with. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
.gif "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.) |
|
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 | (Overrides Object.ToString().) |
Top
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.