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)

public interface IDifferenceViewer : IPropertyOwner

NameDescription
System_CAPS_pubpropertyActiveViewType

Gets or sets the active view that last had focus.

System_CAPS_pubpropertyAreViewsSynchronized

Determines whether the left and right views are synchronized in the side by side view.

System_CAPS_pubpropertyDifferenceBuffer

Gets or sets the IDifferenceBuffer that this viewer is displaying.

System_CAPS_pubpropertyInlineView

Gets or sets the view for displaying Inline differences.

System_CAPS_pubpropertyIsClosed

Determines whether this viewer is closed.

System_CAPS_pubpropertyLeftView

Gets or sets the view for displaying the left buffer for SideBySide differences.

System_CAPS_pubpropertyOptions

Gets or sets the general difference viewer options (DifferenceViewerOptions).

System_CAPS_pubpropertyProperties

(Inherited from IPropertyOwner.)

System_CAPS_pubpropertyRightView

Gets or sets the view for displaying the right buffer for SideBySide differences.

System_CAPS_pubpropertyViewMode

Gets or sets the view mode (inline or side-by-side).

NameDescription
System_CAPS_pubmethodClose()

Closes the viewer and all contained hosts.

System_CAPS_pubmethodScrollToChange(Difference)

Scroll and move the caret to the start of the given difference.

System_CAPS_pubmethodScrollToMatch(Match)

Scroll and move the caret to the start of the given match.

System_CAPS_pubmethodScrollToNextChange(Boolean)

Given the cursor position in the last focused text view, scroll and move the caret to the next difference.

System_CAPS_pubmethodScrollToNextChange(SnapshotPoint, Boolean)

Scroll and move the caret to the next difference after the specified location.

System_CAPS_pubmethodScrollToPreviousChange(Boolean)

Given the cursor position in the last focused text view, scroll and move the caret to the previous difference.

System_CAPS_pubmethodScrollToPreviousChange(SnapshotPoint, Boolean)

Scroll and move the caret to the previous difference before the specified location.

NameDescription
System_CAPS_pubeventClosed

Occurs when the view is closed.

System_CAPS_pubeventViewModeChanged

Occurs when the ViewMode changes.

Return to top
Show: