TextPosition.TranslateTo Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Extensibility.Editor

Assembly:: Microsoft.VisualStudio.Extensibility.Editor.Contracts.dll

Package:: Microsoft.VisualStudio.Extensibility.Editor.Contracts 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.

Translates this TextPosition to an older or newer ITextDocumentSnapshot version.

public Microsoft.VisualStudio.Extensibility.Editor.TextPosition TranslateTo (Microsoft.VisualStudio.Extensibility.Editor.ITextDocumentSnapshot targetDocumentVersion, Microsoft.VisualStudio.Extensibility.Editor.TextPositionTrackingMode trackingMode);

member this.TranslateTo : Microsoft.VisualStudio.Extensibility.Editor.ITextDocumentSnapshot * Microsoft.VisualStudio.Extensibility.Editor.TextPositionTrackingMode -> Microsoft.VisualStudio.Extensibility.Editor.TextPosition

Public Function TranslateTo (targetDocumentVersion As ITextDocumentSnapshot, trackingMode As TextPositionTrackingMode) As TextPosition

Parameters

targetDocumentVersion: ITextDocumentSnapshot

The document version to which to translate.

trackingMode: TextPositionTrackingMode

The TextPositionTrackingMode to use in the translation.

Returns

TextPosition

A TextPosition that has been mapped to the requested document version.

Exceptions

ArgumentNullException

targetDocumentVersion is null.

ArgumentException

targetDocumentVersion does not refer to the same underlying text document as this TextPosition.

Applies to

Share via