ITextView.GetTextViewLineContainingBufferPosition(SnapshotPoint) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor

Assembly:: Microsoft.VisualStudio.Text.UI.dll

Package:: Microsoft.VisualStudio.Text.UI v17.11.260

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the ITextViewLine that contains the specified text buffer position.

public:
 Microsoft::VisualStudio::Text::Formatting::ITextViewLine ^ GetTextViewLineContainingBufferPosition(Microsoft::VisualStudio::Text::SnapshotPoint bufferPosition);

public Microsoft.VisualStudio.Text.Formatting.ITextViewLine GetTextViewLineContainingBufferPosition (Microsoft.VisualStudio.Text.SnapshotPoint bufferPosition);

abstract member GetTextViewLineContainingBufferPosition : Microsoft.VisualStudio.Text.SnapshotPoint -> Microsoft.VisualStudio.Text.Formatting.ITextViewLine

Public Function GetTextViewLineContainingBufferPosition (bufferPosition As SnapshotPoint) As ITextViewLine

Parameters

bufferPosition: SnapshotPoint

The text buffer position used to search for a text line.

Returns

ITextViewLine

The ITextViewLine that contains the specified buffer position.

Exceptions

ArgumentOutOfRangeException

bufferPosition is not a valid buffer position.

InvalidOperationException

if the view has not completed initialization.

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.

The returned ITextViewLine could be invalidated by either a layout by the view or by subsequent calls to this method.

Applies to

Share via