GetNextCaretPosition Method (visualColumn, direction, mode)

Gets the next caret position inside this element.

Declaration Syntax

Visual Basic

Visual C++

public override int GetNextCaretPosition(
	int visualColumn,
	LogicalDirection direction,
	CaretPositioningMode mode
)

Public Overrides Function GetNextCaretPosition ( _
	visualColumn As Integer, _
	direction As LogicalDirection, _
	mode As CaretPositioningMode _
) As Integer

public:
virtual int GetNextCaretPosition(
	int visualColumn, 
	LogicalDirection direction, 
	CaretPositioningMode mode
) override

Parameters

visualColumn (Int32): The visual column from which the search should be started.

direction (LogicalDirection): The search direction (forwards or backwards).

mode (CaretPositioningMode): Whether to stop only at word borders.

Return Value

The visual column of the next caret position, or -1 if there is no next caret position.

Remarks

In the space between two line elements, it is sufficient that one of them contains a caret position; though in many cases, both of them contain one.

Assembly: ICSharpCode.AvalonEdit (Module: ICSharpCode.AvalonEdit.dll) Version: 5.0.0.4238