New to Telerik UI for WinForms? Start a free 30-day trial

Represents a text editor.

Definition

Constructors

Initializes a new instance of the BaseTextBoxEditor class.

C#
public BaseTextBoxEditor()

Fields

Indicates whether the caret was on the first line when the derived key-down hook ran.

C#
protected bool isAtFirstLine

Indicates whether the caret was on the last line when the derived key-down hook ran.

C#
protected bool isAtLastLine

Stores the selected text length captured before the derived key-down hook runs.

C#
protected int selectionLength

Stores the text selection start captured before the derived key-down hook runs.

C#
protected int selectionStart

Properties

Gets or sets whether the editor accepts Enter as a new line in multiline mode.

C#
public bool AcceptsReturn { get; set; }

Gets or sets wheather the editor accepts tha tab key in multiline mode

C#
public bool AcceptsTab { get; set; }

Indicates if all charactes should be left alone or converted to upper or lower case

C#
public CharacterCasing CharacterCasing { get; set; }

Gets string, the type of values produced by this text editor.

C#
public override Type DataType { get; }

Overrides: BaseInputEditor.DataType

Gets whether the value differs from its initialized value or initialization could not preserve the assigned text exactly.

C#
public override bool IsModified { get; }

Overrides: BaseInputEditor.IsModified

Specifies the maximum length of characters which could be entered

C#
public int MaxLength { get; set; }

The text could span more than a line when the value is true

C#
public bool Multiline { get; set; }

Gets or sets the null value for the editor.

C#
public string NullValue { get; set; }

Gets the specialized text-box element used by this editor, or null when its element has another type.

C#
protected BaseTextBoxEditorElement TextBoxEditorElement { get; }

Gets the editor text. Assigning null clears the text; other values are converted with ToString().

C#
public override object Value { get; set; }

Overrides: BaseInputEditor.Value

Methods

Configures and focuses the text input, selects its current text, and subscribes to edit-session events. Theme and multiline settings also determine the text item's background and vertical stretching.

C#
public override void BeginEdit()

Overrides: BaseInputEditor.BeginEdit()

Creates the text-box element that hosts this editor's text input.

C#
protected override RadElement CreateEditorElement()
Returns:

RadElement

Overrides: BaseInputEditor.CreateEditorElement()

Unsubscribes edit-session handlers and clears the text and selection before completing the base edit lifecycle.

C#
public override bool EndEdit()
Returns:

bool

The result of the base editor's end-edit operation.

Overrides: BaseInputEditor.EndEdit()

Resets the editor-specific modification flag before loading the owner and initial value.

C#
public override void Initialize(object owner, object value)
Parameters:ownerobject

The object being edited.

valueobject

The initial value to display.

Overrides: BaseInputEditor.Initialize(object, object)

Provides a key-down hook after the current selection and caret-line state have been captured for derived editors.

C#
protected virtual void OnKeyDown(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Provides a hook invoked when the hosted text box loses focus.

C#
protected virtual void OnLostFocus()