IBufferGraph.MapUpToBuffer Method (SnapshotPoint, PointTrackingMode, PositionAffinity, ITextBuffer)

Maps a position in the current snapshot of some buffer that is a member of the buffer graph to a snapshot of some buffer.

Namespace:  Microsoft.VisualStudio.Text.Projection
Assembly:  Microsoft.VisualStudio.Text.Data (in Microsoft.VisualStudio.Text.Data.dll)

Nullable<SnapshotPoint> MapUpToBuffer(
	SnapshotPoint point,
	PointTrackingMode trackingMode,
	PositionAffinity affinity,
	ITextBuffer targetBuffer
)

Parameters

point
Type: Microsoft.VisualStudio.Text.SnapshotPoint

A point in some buffer in the IBufferGraph.

trackingMode
Type: Microsoft.VisualStudio.Text.PointTrackingMode

How point is tracked to the current snapshot if necessary.

affinity
Type: Microsoft.VisualStudio.Text.PositionAffinity

If the mapping is ambiguous (the position is on a source span seam), determines whether the mapping should target the position immediately after the preceding character or immediately before the following character in the top buffer.

This setting has no effect if the mapping is unambiguous.

targetBuffer
Type: Microsoft.VisualStudio.Text.ITextBuffer

The buffer to which to map.

Return Value

Type: System.Nullable<SnapshotPoint>
The corresponding position in a snapshot of the target buffer, or null if the position does not map to the target buffer.

ExceptionCondition
ArgumentNullException

point.Snapshot is null.

ArgumentOutOfRangeException

trackingMode is not a valid PointTrackingMode, or affinity is not a valid PositionAffinity.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft