CheckinNote Class

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public NotInheritable Class CheckinNote
public sealed class CheckinNote
public ref class CheckinNote sealed
[<Sealed>]
type CheckinNote =  class end
public final class CheckinNote

The CheckinNote type exposes the following members.

Constructors

Name Description
Public method CheckinNote Initializes a new CheckinNote instance.

Top

Properties

Name Description
Public property Values Gets the values of this check-in note.

Top

Methods

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method 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).
Public methodStatic member 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).
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method MergeWithFieldDefinitions For any unspecified CheckinNoteFieldDefinitions that are in scope, add a CheckinNoteFieldValue with an empty string value.
Public method ToString Creates a user-readable string that describes the properties of this check-in note. (Overrides Object.ToString().)

Top

Remarks

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.

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

Reference

Microsoft.TeamFoundation.VersionControl.Client Namespace