This documentation is archived and is not being maintained.

Annotation Class

The Annotation class represents name/value pairs and couples that with optional resourceID, and versioning values. Annotations are used to store application defined name/value pairs -- that is, the application applies the semantic to the values. This class is created for each name/value pair that is read from the database.


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

[ClassVisibilityAttribute(ClientVisibility.Internal, ClientVisibility.Internal)]
public class Annotation

The Annotation type exposes the following members.

Public methodAnnotation

Public propertyAnnotatedItemThis is the item the annotation is applied to. If the item is not supplied, it is a global annotation. You may only specify either a global annotation, or one attached to a versioned Item.
Public propertyAnnotationNameThis is the name of the annotation and is required, each annotation must have a name, although other annotations with the same name may be added to the same item.
Public propertyAnnotationValueThis is the value of the annotation. An annotation is not required to have a value. Its existance may be the value.
Public propertyCommentThis is an optional comment attached to the annotation.
Public propertyLastModifiedDateUTC DateTime of when this annotation was last modified
Public propertyVersionThis is the version of the item that has the annotation attached to it. This is not required and if it is not attached to a specific version, the annotation is valid for all versions.

Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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