Back to all docs
API Reference / Telerik.WinControls.UI / TextBoxNavigator
New to Telerik UI for WinForms? Start a free 30-day trial

TextBoxNavigator

Class

Represent a navigator in RadTextBoxControlElement

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:
C#
public class TextBoxNavigator : ITextBoxNavigator, IDisposable

Inheritance: objectTextBoxNavigator

Derived Classes: AutoCompleteTextNavigator

Implements: IDisposableITextBoxNavigator

Constructors

TextBoxNavigator(RadTextBoxControlElement)

Initializes a new instance of the TextBoxNavigator class.

C#
public TextBoxNavigator(RadTextBoxControlElement textBoxElement)
Parameters:textBoxElementRadTextBoxControlElement

The text box element.

Properties

CaretPosition

Gets or sets the caret position.

C#
public TextPosition CaretPosition { get; set; }
Property Value:

The caret position.

Implements: ITextBoxNavigator.CaretPosition

SelectionEnd

Gets or sets the selection end.

C#
public TextPosition SelectionEnd { get; set; }
Property Value:

The selection end.

Implements: ITextBoxNavigator.SelectionEnd

SelectionLength

Gets the length of the selection.

C#
public int SelectionLength { get; }
Property Value:

The length of the selection.

Implements: ITextBoxNavigator.SelectionLength

SelectionStart

Gets or sets the selection start.

C#
public TextPosition SelectionStart { get; set; }
Property Value:

The selection start.

Implements: ITextBoxNavigator.SelectionStart

TextBoxElement

Gets the associated text box element.

C#
protected RadTextBoxControlElement TextBoxElement { get; }

Methods

~TextBoxNavigator()

C#
protected ~TextBoxNavigator()

Dispose()

C#
public void Dispose()

Implements: IDisposable.Dispose()

Dispose(bool)

C#
protected virtual void Dispose(bool disposing)
Parameters:disposingbool

GetNextPosition(TextPosition, bool)

Gets the next position.

C#
public virtual TextPosition GetNextPosition(TextPosition position, bool isControlPressed)
Parameters:positionTextPosition

The position.

isControlPressedbool

True if Control modifier key is pressed.

Returns:

TextPosition

Implements: ITextBoxNavigator.GetNextPosition(TextPosition, bool)

GetNextPosition(TextPosition)

Gets the next position.

C#
public virtual TextPosition GetNextPosition(TextPosition position)
Parameters:positionTextPosition

The position.

Returns:

TextPosition

Implements: ITextBoxNavigator.GetNextPosition(TextPosition)

GetNextPositionCore(TextPosition)

Gets the next position recursively.

C#
protected virtual TextPosition GetNextPositionCore(TextPosition position)
Parameters:positionTextPosition

The position.

Returns:

TextPosition

GetPositionFromOffset(int)

Gets the position from offset.

C#
public virtual TextPosition GetPositionFromOffset(int offset)
Parameters:offsetint

The offset.

Returns:

TextPosition

Implements: ITextBoxNavigator.GetPositionFromOffset(int)

GetPositionFromPoint(PointF)

Gets the position from point.

C#
public virtual TextPosition GetPositionFromPoint(PointF point)
Parameters:pointPointF

The point.

Returns:

TextPosition

Implements: ITextBoxNavigator.GetPositionFromPoint(PointF)

GetPreviousPosition(TextPosition, bool)

Gets the previous position.

C#
public virtual TextPosition GetPreviousPosition(TextPosition position, bool isControlPressed)
Parameters:positionTextPosition

The position.

isControlPressedbool

True if Control modifier key is pressed.

Returns:

TextPosition

Implements: ITextBoxNavigator.GetPreviousPosition(TextPosition, bool)

GetPreviousPosition(TextPosition)

Gets the previous position.

C#
public virtual TextPosition GetPreviousPosition(TextPosition position)
Parameters:positionTextPosition

The position.

Returns:

TextPosition

Implements: ITextBoxNavigator.GetPreviousPosition(TextPosition)

GetPreviousPositionCore(TextPosition)

Gets the previous position resursively.

C#
protected virtual TextPosition GetPreviousPositionCore(TextPosition position)
Parameters:positionTextPosition

The position.

Returns:

TextPosition

GetTextPositionFromLine(LineInfo, float)

Gets the text position from line.

C#
protected virtual TextPosition GetTextPositionFromLine(LineInfo line, float x)
Parameters:lineLineInfo

The line.

xfloat

The x.

Returns:

TextPosition

Navigate(KeyEventArgs)

Navigates by specified keys.

C#
public virtual bool Navigate(KeyEventArgs keys)
Parameters:keysKeyEventArgs

The KeyEventArgs instance containing the event data.

Returns:

bool

Implements: ITextBoxNavigator.Navigate(KeyEventArgs)

NavigateAtLine(KeyEventArgs, TextPosition)

Navigates at line.

C#
protected virtual TextPosition NavigateAtLine(KeyEventArgs keys, TextPosition position)
Parameters:keysKeyEventArgs

The KeyEventArgs instance containing the event data.

positionTextPosition

The position.

Returns:

TextPosition

NavigateToLine(KeyEventArgs, TextPosition)

Navigates to line.

C#
protected virtual TextPosition NavigateToLine(KeyEventArgs keys, TextPosition position)
Parameters:keysKeyEventArgs

The KeyEventArgs instance containing the event data.

positionTextPosition

The position.

Returns:

TextPosition

OnSelectionChanged(SelectionChangedEventArgs)

Raises the event.

C#
protected virtual void OnSelectionChanged(SelectionChangedEventArgs e)
Parameters:eSelectionChangedEventArgs

The SelectionChangedEventArgs instance containing the event data.

OnSelectionChanging(SelectionChangingEventArgs)

Raises the event.

C#
protected virtual void OnSelectionChanging(SelectionChangingEventArgs e)
Parameters:eSelectionChangingEventArgs

The SelectionChangingEventArgs instance containing the event data.

RestoreSelection()

Restores the saved selection position.

C#
public virtual void RestoreSelection()

Implements: ITextBoxNavigator.RestoreSelection()

ResumeNotifications()

Resumes the notifications.

C#
public void ResumeNotifications()

Implements: ITextBoxNavigator.ResumeNotifications()

SaveSelection()

Saves the current selection position.

C#
public virtual void SaveSelection()

Implements: ITextBoxNavigator.SaveSelection()

ScrollToCaret()

Scrolls to caret position.

C#
public virtual bool ScrollToCaret()
Returns:

bool

Implements: ITextBoxNavigator.ScrollToCaret()

Select(TextPosition, TextPosition)

Selects the specified range.

C#
public virtual bool Select(TextPosition start, TextPosition end)
Parameters:startTextPosition

The start.

endTextPosition

The end.

Returns:

bool

Implements: ITextBoxNavigator.Select(TextPosition, TextPosition)

SelectOverride(bool)

Selects the override.

C#
protected virtual void SelectOverride(bool notify)
Parameters:notifybool

if set to true [notify].

SetCaretPosition()

Sets the caret position.

C#
public virtual void SetCaretPosition()

SuspendNotifications()

Suspends the notifications.

C#
public void SuspendNotifications()

Implements: ITextBoxNavigator.SuspendNotifications()

Events

SelectionChanged

Occurs when selection is changed.

C#
public event SelectionChangedEventHandler SelectionChanged

Implements: ITextBoxNavigator.SelectionChanged

SelectionChanging

Occurs when selection is changing.

C#
public event SelectionChangingEventHandler SelectionChanging

Implements: ITextBoxNavigator.SelectionChanging

In this article
DefinitionConstructorsTextBoxNavigator(RadTextBoxControlElement)PropertiesCaretPositionSelectionEndSelectionLengthSelectionStartTextBoxElementMethods~TextBoxNavigator()Dispose()Dispose(bool)GetNextPosition(TextPosition, bool)GetNextPosition(TextPosition)GetNextPositionCore(TextPosition)GetPositionFromOffset(int)GetPositionFromPoint(PointF)GetPreviousPosition(TextPosition, bool)GetPreviousPosition(TextPosition)GetPreviousPositionCore(TextPosition)GetTextPositionFromLine(LineInfo, float)Navigate(KeyEventArgs)NavigateAtLine(KeyEventArgs, TextPosition)NavigateToLine(KeyEventArgs, TextPosition)OnSelectionChanged(SelectionChangedEventArgs)OnSelectionChanging(SelectionChangingEventArgs)RestoreSelection()ResumeNotifications()SaveSelection()ScrollToCaret()Select(TextPosition, TextPosition)SelectOverride(bool)SetCaretPosition()SuspendNotifications()EventsSelectionChangedSelectionChanging
Not finding the help you need?
Contact Support