IDifferenceViewer Interface
A difference viewer is a container for viewing an IDifferenceBuffer in an inline or side-by-side mode. It keeps the scroll state of the different views in sync, and provides helpers for scrolling to differences and matches in all views.
Namespace: Microsoft.VisualStudio.Text.Differencing
Assembly: Microsoft.VisualStudio.Text.UI (in Microsoft.VisualStudio.Text.UI.dll)
Syntax
'Declaration
Public Interface IDifferenceViewer _
Inherits IPropertyOwner
public interface IDifferenceViewer : IPropertyOwner
public interface class IDifferenceViewer : IPropertyOwner
type IDifferenceViewer =
interface
interface IPropertyOwner
end
public interface IDifferenceViewer extends IPropertyOwner
The IDifferenceViewer type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ActiveViewType | Gets or sets the active view that last had focus. |
|
AreViewsSynchronized | Determines whether the left and right views are synchronized in the side by side view. |
|
DifferenceBuffer | Gets or sets the IDifferenceBuffer that this viewer is displaying. |
|
InlineView | Gets or sets the view for displaying Inline differences. |
|
IsClosed | Determines whether this viewer is closed. |
|
LeftView | Gets or sets the view for displaying the left buffer for SideBySide differences. |
|
Options | Gets or sets the general difference viewer options (DifferenceViewerOptions). |
|
Properties | Gets the collection of properties controlled by the property owner. (Inherited from IPropertyOwner.) |
|
RightView | Gets or sets the view for displaying the right buffer for SideBySide differences. |
|
ViewMode | Gets or sets the view mode (inline or side-by-side). |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Close | Closes the viewer and all contained hosts. |
|
ScrollToChange | Scroll and move the caret to the start of the given difference. |
|
ScrollToMatch | Scroll and move the caret to the start of the given match. |
|
ScrollToNextChange(Boolean) | Given the cursor position in the last focused text view, scroll and move the caret to the next difference. |
|
ScrollToNextChange(SnapshotPoint, Boolean) | Scroll and move the caret to the next difference after the specified location. |
|
ScrollToPreviousChange(Boolean) | Given the cursor position in the last focused text view, scroll and move the caret to the previous difference. |
|
ScrollToPreviousChange(SnapshotPoint, Boolean) | Scroll and move the caret to the previous difference before the specified location. |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Closed | Occurs when the view is closed. |
|
ViewModeChanged | Occurs when the ViewMode changes. |
Top