TextEdit Class

A text editor.

Namespace: DevExpress.Xpf.Editors

Assembly: DevExpress.Xpf.Core.v20.2.dll

Declaration

public class TextEdit :
    TextEditBase,
    ISupportTextHighlighting
Public Class TextEdit
    Inherits TextEditBase
    Implements ISupportTextHighlighting

Remarks

TextEdit Context Menu

The TextEdit is a single-line text editor by default. To enable multi-line editing, set the TextEditBase.TextWrapping property to Wrap.

TIP

The TextEdit class inherits its features from the TextEditBase class.

Refer to the TextEditBase class description for information on derived features and API.

Create a TextEdit

To specify the editor's value, use the BaseEdit.EditValue or TextEditBase.Text property.

<Window ...
    xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors">

<!-- Use the TextEditBase.Text property to specify a value -->
<dxe:TextEdit Text="Hello World!"/>

<!-- Use the BaseEdit.EditValue property to specify a value -->
<dxe:TextEdit EditValue="Hello World!"/>

To respond to editor value changes, handle the BaseEdit.EditValueChanged event. To validate the new value, handle the BaseEdit.Validate event.

Character Casing

If the CharacterCasing property is set to Upper or Lower, the editor's new values will be automatically converted to the corresponding case.

Masked Input

The TextEdit allows you to use masks when text is edited. To learn more, see the following help topic: Masked Input.

Text Selection

To enable automatic text selection when the keyboard is used to focus an editor, set the SelectAllOnGotFocus property to true. To enable text selection when a mouse click focuses an editor, set the SelectAllOnMouseUp to true.

To select all text within an editor manually, use the SelectAll method. To select only specified text, use the TextEdit.Select(System.Int32,System.Int32) method.

When an end user double-clicks a word in a text edit, the focused word is selected. When an end user clicks 3 times, all the editor's text is selected (that is the same as calling the SelectAll method).

Spin Input

You can use the TextEdit.AllowSpin property to specify whether a user can use a spin editor to change an editor value with Up and Down keys.

When TextEdit.AllowSpin is true, use the TextEdit.AllowSpinOnMouseWheel property to specify whether a user can spin the mouse wheel to change an editor value.

The TextEdit.SpinUp method is in effect if the editor's TextEdit.MaskType property is set to MaskType.Numeric or MaskType.DateTime.

To decrement the editor value, use the TextEdit.SpinDown method. If you call the TextEdit.SpinUp or TextEdit.SpinDown method, the TextEdit.Spin event is fired.

In-Place TextEdit

To embed a TextEdit into a container control, use the TextEditSettings class.

See Also