IScrollMap.GetBufferPositionAtCoordinate(Double) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor

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

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

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 buffer position that corresponds to a scrollmap coordinate.

public:
 Microsoft::VisualStudio::Text::SnapshotPoint GetBufferPositionAtCoordinate(double coordinate);

public Microsoft.VisualStudio.Text.SnapshotPoint GetBufferPositionAtCoordinate (double coordinate);

abstract member GetBufferPositionAtCoordinate : double -> Microsoft.VisualStudio.Text.SnapshotPoint

Public Function GetBufferPositionAtCoordinate (coordinate As Double) As SnapshotPoint

Parameters

coordinate: Double

The scrollmap coordinate.

Returns

SnapshotPoint

The corresponding buffer position.

Exceptions

ArgumentOutOfRangeException

coordinate is NaN.

Remarks

Different buffer positions can have the same scroll map coordinates. This method is guaranteed only to be consistent: it will return the same position for the same coordinate. The exact character returned will depend on the implementation of the scroll map. It will generally be the first character on the line.

Applies to

Share via