ITextView::GetTextViewLineContainingBufferPosition Method (SnapshotPoint)

Visual Studio 2015

Gets the ITextViewLine that contains the specified text buffer position.

Namespace: Microsoft.VisualStudio.Text.Editor
Assembly: Microsoft.VisualStudio.Text.UI (in Microsoft.VisualStudio.Text.UI.dll)

Syntax

C++

ITextViewLine^ GetTextViewLineContainingBufferPosition(
	SnapshotPoint bufferPosition
)

Parameters

bufferPosition: Type: Microsoft.VisualStudio.Text::SnapshotPoint
The text buffer position used to search for a text line.

Return Value

Type: Microsoft.VisualStudio.Text.Formatting::ITextViewLine^

The ITextViewLine that contains the specified buffer position.

Exceptions

Exception	Condition
InvalidOperationException	The view has not completed initialization.
ArgumentOutOfRangeException	bufferPosition is not a valid buffer position.

Remarks

This method returns an ITextViewLine if it exists in the view. If the line does not exist in the cache of formatted lines, it will be formatted and added to the cache.