VersionControlAnnotate Class

Wrapper for an Annotate tool window.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.TeamFoundation.VersionControl.VersionControlBaseToolWindowExt
Microsoft.VisualStudio.TeamFoundation.VersionControl.VersionControlAnnotate

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

Syntax

'Declaration
Public NotInheritable Class VersionControlAnnotate _
    Inherits VersionControlBaseToolWindowExt
public sealed class VersionControlAnnotate : VersionControlBaseToolWindowExt
public ref class VersionControlAnnotate sealed : public VersionControlBaseToolWindowExt
[<Sealed>]
type VersionControlAnnotate =  
    class 
        inherit VersionControlBaseToolWindowExt 
    end
public final class VersionControlAnnotate extends VersionControlBaseToolWindowExt

The VersionControlAnnotate type exposes the following members.

Properties

Name Description
Public property ChangesetId Get the changeset ID of the version of the file that was annotated. If the changeset is null (ex: file has local edits), 0 will be returned.
Public property DeletionId Get the deletion ID of the file displayed in this annotation viewer.
Public property IsBusy Returns true if the annotate operation has not been completed.
Public property ItemPath Get the path of the item displayed in this annotation viewer. This is the item that was originally annotated, and may be either a local or server path.
Public property LineCount Get the number of lines displayed in this annotation viewer.
Public property Regions Get the annotate regions for this annotation viewer. The region array cannot be retrieved until the annotate operation has completed.
Public property SelectedRegions Get the selected annotate region for this annotation viewer. The selected region is the only region available before the annotate operation has completed.
Public property ServerItem Get the server path of the item displayed in this annotation viewer.
Public property VersionSpec Get the version of the file displayed in this annotation viewer.
Public property VsWindowFrame Get the IVsWindowFrame for this tool window. (Inherited from VersionControlBaseToolWindowExt.)

Top

Methods

Name Description
Public method Close Close this annotation viewer.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetRegionForLine Get the annotate region for the specified line. Regions cannot be retrieved until the annotate operation has completed.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method MoveNextRegion Move focus to the annotate region that follows the selected region.
Public method MovePreviousRegion Move focus to the annotate region that comes before the selected region.
Public method Stop Stop the current annotate operation.
Public method 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.

See Also

Reference

Microsoft.VisualStudio.TeamFoundation.VersionControl Namespace