Class
TextBoxNavigator

Represent a navigator in RadTextBoxControlElement

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

cs-api-definition
public class TextBoxNavigator : ITextBoxNavigator, IDisposable

Inheritance: objectTextBoxNavigator

Derived Classes: AutoCompleteTextNavigator

Implements: IDisposableITextBoxNavigator

Constructors

TextBoxNavigator(RadTextBoxControlElement)

Initializes a new instance of the TextBoxNavigator class.

Declaration

cs-api-definition
public TextBoxNavigator(RadTextBoxControlElement textBoxElement)

Parameters

textBoxElement

RadTextBoxControlElement

The text box element.

Properties

CaretPosition

Gets or sets the caret position.

Declaration

cs-api-definition
public TextPosition CaretPosition { get; set; }

Property Value

TextPosition

The caret position.

Implements ITextBoxNavigator.CaretPosition

SelectionEnd

Gets or sets the selection end.

Declaration

cs-api-definition
public TextPosition SelectionEnd { get; set; }

Property Value

TextPosition

The selection end.

Implements ITextBoxNavigator.SelectionEnd

SelectionLength

Gets the length of the selection.

Declaration

cs-api-definition
public int SelectionLength { get; }

Property Value

int

The length of the selection.

Implements ITextBoxNavigator.SelectionLength

SelectionStart

Gets or sets the selection start.

Declaration

cs-api-definition
public TextPosition SelectionStart { get; set; }

Property Value

TextPosition

The selection start.

Implements ITextBoxNavigator.SelectionStart

TextBoxElement

Gets the associated text box element.

Declaration

cs-api-definition
protected RadTextBoxControlElement TextBoxElement { get; }

Property Value

RadTextBoxControlElement

Methods

Dispose()

Declaration

cs-api-definition
public void Dispose()

Implements IDisposable.Dispose()

Dispose(bool)

Declaration

cs-api-definition
protected virtual void Dispose(bool disposing)

Parameters

disposing

bool

GetNextPosition(TextPosition)

Gets the next position.

Declaration

cs-api-definition
public virtual TextPosition GetNextPosition(TextPosition position)

Parameters

position

TextPosition

The position.

Returns

TextPosition

Implements ITextBoxNavigator.GetNextPosition(TextPosition)

GetNextPosition(TextPosition, bool)

Gets the next position.

Declaration

cs-api-definition
public virtual TextPosition GetNextPosition(TextPosition position, bool isControlPressed)

Parameters

position

TextPosition

The position.

isControlPressed

bool

True if Control modifier key is pressed.

Returns

TextPosition

Implements ITextBoxNavigator.GetNextPosition(TextPosition, bool)

GetNextPositionCore(TextPosition)

Gets the next position recursively.

Declaration

cs-api-definition
protected virtual TextPosition GetNextPositionCore(TextPosition position)

Parameters

position

TextPosition

The position.

Returns

TextPosition

GetPositionFromOffset(int)

Gets the position from offset.

Declaration

cs-api-definition
public virtual TextPosition GetPositionFromOffset(int offset)

Parameters

offset

int

The offset.

Returns

TextPosition

Implements ITextBoxNavigator.GetPositionFromOffset(int)

GetPositionFromPoint(PointF)

Gets the position from point.

Declaration

cs-api-definition
public virtual TextPosition GetPositionFromPoint(PointF point)

Parameters

point

PointF

The point.

Returns

TextPosition

Implements ITextBoxNavigator.GetPositionFromPoint(PointF)

GetPreviousPosition(TextPosition)

Gets the previous position.

Declaration

cs-api-definition
public virtual TextPosition GetPreviousPosition(TextPosition position)

Parameters

position

TextPosition

The position.

Returns

TextPosition

Implements ITextBoxNavigator.GetPreviousPosition(TextPosition)

GetPreviousPosition(TextPosition, bool)

Gets the previous position.

Declaration

cs-api-definition
public virtual TextPosition GetPreviousPosition(TextPosition position, bool isControlPressed)

Parameters

position

TextPosition

The position.

isControlPressed

bool

True if Control modifier key is pressed.

Returns

TextPosition

Implements ITextBoxNavigator.GetPreviousPosition(TextPosition, bool)

GetPreviousPositionCore(TextPosition)

Gets the previous position resursively.

Declaration

cs-api-definition
protected virtual TextPosition GetPreviousPositionCore(TextPosition position)

Parameters

position

TextPosition

The position.

Returns

TextPosition

GetTextPositionFromLine(LineInfo, float)

Gets the text position from line.

Declaration

cs-api-definition
protected virtual TextPosition GetTextPositionFromLine(LineInfo line, float x)

Parameters

line

LineInfo

The line.

x

float

The x.

Returns

TextPosition

Navigate(KeyEventArgs)

Navigates by specified keys.

Declaration

cs-api-definition
public virtual bool Navigate(KeyEventArgs keys)

Parameters

keys

KeyEventArgs

The KeyEventArgs instance containing the event data.

Returns

bool

Implements ITextBoxNavigator.Navigate(KeyEventArgs)

NavigateAtLine(KeyEventArgs, TextPosition)

Navigates at line.

Declaration

cs-api-definition
protected virtual TextPosition NavigateAtLine(KeyEventArgs keys, TextPosition position)

Parameters

keys

KeyEventArgs

The KeyEventArgs instance containing the event data.

position

TextPosition

The position.

Returns

TextPosition

NavigateToLine(KeyEventArgs, TextPosition)

Navigates to line.

Declaration

cs-api-definition
protected virtual TextPosition NavigateToLine(KeyEventArgs keys, TextPosition position)

Parameters

keys

KeyEventArgs

The KeyEventArgs instance containing the event data.

position

TextPosition

The position.

Returns

TextPosition

OnSelectionChanged(SelectionChangedEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnSelectionChanged(SelectionChangedEventArgs e)

Parameters

e

SelectionChangedEventArgs

The SelectionChangedEventArgs instance containing the event data.

OnSelectionChanging(SelectionChangingEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnSelectionChanging(SelectionChangingEventArgs e)

Parameters

e

SelectionChangingEventArgs

The SelectionChangingEventArgs instance containing the event data.

RestoreSelection()

Restores the saved selection position.

Declaration

cs-api-definition
public virtual void RestoreSelection()

Implements ITextBoxNavigator.RestoreSelection()

ResumeNotifications()

Resumes the notifications.

Declaration

cs-api-definition
public void ResumeNotifications()

Implements ITextBoxNavigator.ResumeNotifications()

SaveSelection()

Saves the current selection position.

Declaration

cs-api-definition
public virtual void SaveSelection()

Implements ITextBoxNavigator.SaveSelection()

ScrollToCaret()

Scrolls to caret position.

Declaration

cs-api-definition
public virtual bool ScrollToCaret()

Returns

bool

Implements ITextBoxNavigator.ScrollToCaret()

Select(TextPosition, TextPosition)

Selects the specified range.

Declaration

cs-api-definition
public virtual bool Select(TextPosition start, TextPosition end)

Parameters

start

TextPosition

The start.

end

TextPosition

The end.

Returns

bool

Implements ITextBoxNavigator.Select(TextPosition, TextPosition)

SelectOverride(bool)

Selects the override.

Declaration

cs-api-definition
protected virtual void SelectOverride(bool notify)

Parameters

notify

bool

if set to true [notify].

SetCaretPosition()

Sets the caret position.

Declaration

cs-api-definition
public virtual void SetCaretPosition()

SuspendNotifications()

Suspends the notifications.

Declaration

cs-api-definition
public void SuspendNotifications()

Implements ITextBoxNavigator.SuspendNotifications()

~TextBoxNavigator()

Declaration

cs-api-definition
protected ~TextBoxNavigator()

Events

SelectionChanged

Occurs when selection is changed.

Declaration

cs-api-definition
public event SelectionChangedEventHandler SelectionChanged

Event Value

SelectionChangedEventHandler

Implements ITextBoxNavigator.SelectionChanged

SelectionChanging

Occurs when selection is changing.

Declaration

cs-api-definition
public event SelectionChangingEventHandler SelectionChanging

Event Value

SelectionChangingEventHandler

Implements ITextBoxNavigator.SelectionChanging