Export (0) Print
Expand All

CheckinNote Class

Represents the check-in notes that are part of a changeset.

System::Object
  Microsoft.TeamFoundation.VersionControl.Client::CheckinNote

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

public ref class CheckinNote sealed

The CheckinNote type exposes the following members.

  NameDescription
Public methodCheckinNoteInitializes a new CheckinNote instance.
Top

  NameDescription
Public propertyValuesGets the values of this check-in note.
Top

  NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodEvaluate(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).
Public methodStatic memberEvaluate(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).
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMergeWithFieldDefinitionsFor any unspecified CheckinNoteFieldDefinitions that are in scope, add a CheckinNoteFieldValue with an empty string value.
Public methodToStringCreates a user-readable string that describes the properties of this check-in note. (Overrides Object::ToString().)
Top

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.

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