ITextCaret.MoveTo Method (SnapshotPoint, PositionAffinity)

Moves the caret to the given index in the underlying ITextBuffer.

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

Syntax

'Declaration
Function MoveTo ( _
    bufferPosition As SnapshotPoint, _
    caretAffinity As PositionAffinity _
) As CaretPosition

CaretPosition MoveTo(
    SnapshotPoint bufferPosition,
    PositionAffinity caretAffinity
)

CaretPosition MoveTo(
    SnapshotPoint bufferPosition, 
    PositionAffinity caretAffinity
)

abstract MoveTo : 
        bufferPosition:SnapshotPoint * 
        caretAffinity:PositionAffinity -> CaretPosition

function MoveTo(
    bufferPosition : SnapshotPoint, 
    caretAffinity : PositionAffinity
) : CaretPosition

Parameters

• bufferPosition
  Type: Microsoft.VisualStudio.Text.SnapshotPoint

  The SnapshotPoint in the underlying text buffer to which to move the caret.

• caretAffinity
  Type: Microsoft.VisualStudio.Text.PositionAffinity

  The affinity of the caret. This is ignored unless bufferPosition specifies a location that is at the seam between two word-wrapped lines.

Return Value

Type: Microsoft.VisualStudio.Text.Editor.CaretPosition
A CaretPosition that contains the valid values of the caret position after the move has occurred.

Remarks

This is equivalent to calling MoveTo(bufferPosition, caretAffinity, true).

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

ITextCaret Interface

MoveTo Overload

Microsoft.VisualStudio.Text.Editor Namespace