IDifferenceViewer Interface

Definition

Namespace:

Microsoft.VisualStudio.Text.Differencing

Assembly:

Microsoft.VisualStudio.Text.UI.dll

Package:

Microsoft.VisualStudio.Text.UI v17.12.215

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.

public interface class IDifferenceViewer : Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface class IDifferenceViewer : Microsoft::VisualStudio::Utilities::IPropertyOwner

__interface IDifferenceViewer : Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface IDifferenceViewer : Microsoft.VisualStudio.Utilities.IPropertyOwner

type IDifferenceViewer = interface
    interface IPropertyOwner

Public Interface IDifferenceViewer
Implements IPropertyOwner

Derived

Microsoft.VisualStudio.Text.Differencing.IDifferenceViewer2

Microsoft.VisualStudio.Text.Differencing.IDifferenceViewer3

Microsoft.VisualStudio.Text.Differencing.IWpfDifferenceViewer

Implements

IPropertyOwner

Properties

ActiveViewType	Identifies the active view that last had focus.
AreViewsSynchronized	Are the left and right views are synchronized in the side by side view.
DifferenceBuffer	The IDifferenceBuffer that this viewer is displaying.
InlineView	The view for displaying Inline differences.
IsClosed	Determine if this viewer is closed.
LeftView	The view for displaying the left buffer for SideBySide differences.
Options	Used to get or set general difference viewer options (DifferenceViewerOptions).
Properties	The collection of properties controlled by the property owner. (Inherited from IPropertyOwner)
RightView	The view for displaying the right buffer for SideBySide differences.
ViewMode	The view mode (inline or side-by-side).

Methods

Close()	Close the viewer and all contained hosts.
ScrollToChange(Difference)	Scroll and move the caret to the start of the given difference.
ScrollToMatch(Match)	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.

Events

Closed	Raised when the view is closed.
ViewModeChanged	Raised when the ViewMode changes.