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 | |
---|---|---|
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. | |
DeletionId | Get the deletion ID of the file displayed in this annotation viewer. | |
IsBusy | Returns true if the annotate operation has not been completed. | |
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. | |
LineCount | Get the number of lines displayed in this annotation viewer. | |
Regions | Get the annotate regions for this annotation viewer. The region array cannot be retrieved until the annotate operation has completed. | |
SelectedRegions | Get the selected annotate region for this annotation viewer. The selected region is the only region available before the annotate operation has completed. | |
ServerItem | Get the server path of the item displayed in this annotation viewer. | |
VersionSpec | Get the version of the file displayed in this annotation viewer. | |
VsWindowFrame | Get the IVsWindowFrame for this tool window. (Inherited from VersionControlBaseToolWindowExt.) |
Top
Methods
Name | Description | |
---|---|---|
Close | Close this annotation viewer. | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetRegionForLine | Get the annotate region for the specified line. Regions cannot be retrieved until the annotate operation has completed. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MoveNextRegion | Move focus to the annotate region that follows the selected region. | |
MovePreviousRegion | Move focus to the annotate region that comes before the selected region. | |
Stop | Stop the current annotate operation. | |
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