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.
Inheritance Hierarchy
System.Object
Microsoft.TeamFoundation.VersionControl.Server.Annotation
Namespace: Microsoft.TeamFoundation.VersionControl.Server
Assembly: Microsoft.TeamFoundation.VersionControl.Server (in Microsoft.TeamFoundation.VersionControl.Server.dll)
Syntax
'Declaration
<ClassVisibilityAttribute(ClientVisibility.Internal, ClientVisibility.Internal)> _
Public Class Annotation
[ClassVisibilityAttribute(ClientVisibility.Internal, ClientVisibility.Internal)]
public class Annotation
[ClassVisibilityAttribute(ClientVisibility::Internal, ClientVisibility::Internal)]
public ref class Annotation
[<ClassVisibilityAttribute(ClientVisibility.Internal, ClientVisibility.Internal)>]
type Annotation = class end
public class Annotation
The Annotation type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
Annotation |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AnnotatedItem | This 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. |
|
AnnotationName | This 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. |
|
AnnotationValue | This is the value of the annotation. An annotation is not required to have a value. Its existance may be the value. |
|
Comment | This is an optional comment attached to the annotation. |
|
LastModifiedDate | UTC DateTime of when this annotation was last modified |
|
Version | This 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. |
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 a hash function for a particular type. (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 | Returns a string that represents the current object. (Inherited from Object.) |
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.