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.Data.Tools.Delta
Assembly: Microsoft.VisualStudio.Data.Tools.Delta (in Microsoft.VisualStudio.Data.Tools.Delta.dll)
Syntax
'Declaration
Public Interface IDifferenceViewer _
Inherits IPropertyOwner
'Usage
Dim instance As IDifferenceViewer
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 | |
---|---|---|
DifferenceBuffer | The IDifferenceBuffer that this viewer is displaying. | |
HighlightMode | The highlight mode of the InlineHost. | |
InlineHost | The host for displaying Inline differences. | |
IsClosed | Determine if this viewer is closed. | |
LeftHost | The host for displaying the left buffer for SideBySide differences. | |
LeftPanel | The left panel, containing the left buffer. | |
Options | Used to get or set general difference viewer options (DifferenceViewerOptions). | |
Properties | (Inherited from IPropertyOwner.) | |
RightHost | The host for displaying the right buffer for SideBySide differences. | |
RightPanel | The right panel, containing the right buffer. | |
ViewMode | The view mode (inline or side-by-side). | |
VisualElement | The visual element of this viewer. | |
ZoomLevel | Gets or sets the Zoom level for the enclosed text views between 20% to 400% |
Top
Methods
Name | Description | |
---|---|---|
Close | Close the viewer and all contained hosts. | |
ScrollToChange | Scroll to the start of the given difference. | |
ScrollToMatch | Scroll to the start of the given match. | |
ScrollToNextChange | Given the cursor position in the last focused text view, scroll to the next difference. | |
ScrollToPreviousChange | Given the cursor position in the last focused text view, scroll to the previous difference. |
Top
Events
Name | Description | |
---|---|---|
Closed | Raised when the view is closed. | |
GotAggregateFocus | Raised when one of the component delta items receives the focus. | |
HighlightModeChanged | Raised when the HighlightMode changes. | |
InitializationFinished | Raised when the viewer is fully initialized, meaning the DifferenceBuffer has computed the first diff. At this point, calling any method on this viewer is valid. | |
ViewModeChanged | Raised when the ViewMode changes. | |
ZoomLevelChanged | Raised when the zoom level of the component delta items is changed. |
Top