This documentation is archived and is not being maintained.
CheckinNote Class
Visual Studio 2013
Represents the check-in notes that are part of a changeset.
Namespace: Microsoft.TeamFoundation.VersionControl.Client
Assembly: Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)
The CheckinNote type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | Evaluate(array<CheckinNoteFieldDefinition>) | Evaluates this CheckinNote's CheckinNoteFieldValues against the supplied CheckinNoteFieldDefinitions and returns a CheckinNoteFailure for each note not specified, or each note specified that has no definition (extraneous notes). |
![]() ![]() | Evaluate(CheckinNote, array<CheckinNoteFieldDefinition>) | Evaluates a CheckinNote's CheckinNoteFieldValues against the supplied CheckinNoteFieldDefinitions and returns a CheckinNoteFailure for each note not specified, or each note specified that has no definition (extraneous notes). |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MergeWithFieldDefinitions | For any unspecified CheckinNoteFieldDefinitions that are in scope, add a CheckinNoteFieldValue with an empty string value. |
![]() | ToString | Creates a user-readable string that describes the properties of this check-in note. (Overrides Object::ToString().) |
A field definition is used to define how a named input is treated when it is applied to a check-in note. These are not versioned and can change over time. This 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.
Show:
