Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ITextView.DisplayTextLineContainingBufferPosition Method (SnapshotPoint, Double, ViewRelativePosition)

Formats and displays the contents of the text buffer so that the ITextViewLine containing the buffer position is displayed at the desired position.

Namespace:  Microsoft.VisualStudio.Text.Editor
Assembly:  Microsoft.VisualStudio.Text.UI (in Microsoft.VisualStudio.Text.UI.dll)
void DisplayTextLineContainingBufferPosition(
	SnapshotPoint bufferPosition,
	double verticalDistance,
	ViewRelativePosition relativeTo
)

Parameters

bufferPosition
Type: Microsoft.VisualStudio.Text.SnapshotPoint

The position of the character that is to be contained in the ITextViewLine displayed at the specified vertical position.

verticalDistance
Type: System.Double

The distance (in pixels) between the ITextViewLine and the edge of the view. If relativeTo is equal to ViewRelativePosition.Top, then the distance is from the top of the view to the top of the ITextViewLine. Otherwise, it is the distance from the bottom of the ITextViewLine to the bottom on the view.

Negative values are allowed, which may cause the line to be displayed outside the viewport.

This method can become quite expensive if verticalDistance is large. You should avoid making verticalDistance greater than the height of the view.

relativeTo
Type: Microsoft.VisualStudio.Text.Editor.ViewRelativePosition

The ViewRelativePosition.

ExceptionCondition
ArgumentException

bufferPosition is from the wrong ITextSnapshot or ITextBuffer.

ArgumentOutOfRangeException

relativeTo is not a valid ViewRelativePosition.

If word wrap is disabled in the view, then the ITextViewLine corresponds to the entire ITextSnapshotLine that contains bufferPosition. If word wrap is enabled in the view, then the ITextViewLine corresponds to the portion of the ITextSnapshotLine that both contains bufferPosition and fits into the view. bufferPosition may not be the first character in the ITextViewLine. The returned value is generally equal to verticalDistance, except when the view was repositioned to prevent a gap from appearing at the top or bottom of the view. Calling this method causes the view to dispose of its current TextViewLines.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.