windowsforms-devexpress-dot-xtraeditors-95c05e5b.md
A single-line text editor.
Namespace : DevExpress.XtraEditors
Assembly : DevExpress.XtraEditors.v25.2.dll
NuGet Package : DevExpress.Win.Navigation
[DefaultBindingPropertyEx("Text")]
[DXLicenseWinFormsEditors]
public class TextEdit :
BaseEdit,
ITextEditControllerProvider,
IValidationHintCornerRadiusProvider,
IDXMenuSupport,
IMouseWheelSupport,
ISupportsBaselineAlignment,
ISupportsAutoSize,
IDirectXClientProviderEx,
IDirectXClientProvider,
ITextEditControllerOwner,
IChildAccessibleInfoProvider,
ISupportsAdvancedMode
<DefaultBindingPropertyEx("Text")>
<DXLicenseWinFormsEditors>
Public Class TextEdit
Inherits BaseEdit
Implements ITextEditControllerProvider,
IValidationHintCornerRadiusProvider,
IDXMenuSupport,
IMouseWheelSupport,
ISupportsBaselineAlignment,
ISupportsAutoSize,
IDirectXClientProviderEx,
IDirectXClientProvider,
ITextEditControllerOwner,
IChildAccessibleInfoProvider,
ISupportsAdvancedMode
The following members return TextEdit objects:
The TextEdit.Properties property allows access to the RepositoryItemTextEdit object - a repository item that stores editor settings.
The image below shows a text edit:
Tip
Use the MemoEdit control to display and edit multi-line text.
The following table enumerates main TextEdit API:
|
Description
|
API
| | --- | --- | |
Editor text
|
BaseEdit.Text
BaseEdit.EditValue
| |
Character casing (normal, uppercase, or lowercase)
|
RepositoryItemTextEdit.CharacterCasing
| |
Maximum text length
|
RepositoryItemTextEdit.MaxLength
| |
Default text shown when the editor is empty
|
RepositoryItem.NullText
RepositoryItemTextEdit.NullValuePrompt
| |
Methods that manage the caret’s position and text selection
|
TextEdit.SelectionStart
TextEdit.SelectionLength
TextEdit.SelectedText
TextEdit.SelectAll
TextEdit.DeselectAll
| |
Clipboard operations
|
TextEdit.Copy
TextEdit.Cut
TextEdit.Paste
| |
Shortcuts
|
LEFT or UP arrow - moves the caret forward
RIGHT or DOWN arrow - moves the caret backwards
Ctrl+A - selects all text in the editor
Ctrl+Backspace - deletes an entire word to the left of the current cursor position
Ctrl+Del - clears the text box
Ctrl+Z - restores the previous value
Ctrl+C or Ctrl+Ins - copies selected text to clipboard
Ctrl+V or Shift+Ins - pastes text from clipboard
Ctrl+X or Shift+Del - cuts selected text
TextEditAdvancedModeOptions.ShortcutsEnabled - disables shortcuts
| |
Context Menu
|
|
Editors derived from the TextEdit class have the same features. You can modify the TextEditStyle property (for instance, RepositoryItemButtonEdit.TextEditStyle) to disable or hide the text box and prevent users from entering values.
Tip
If you need to work with values other than strings, you can use input masks or data-specific editors (for example, SpinEdit for numeric values, DateEdit for DateTime values, etc.). DevExpress data editors are fully customizable. You can hide UI buttons and dropdowns to make them look like a TextEdit.
All editors derived from the TextEdit class (except for RepositoryItemHypertextLabel and HyperLinkEdit) can operate in Advanced Mode. In this mode editors use a custom DevExpress text box instead of the standard Windows Forms masked box. This custom text box supports unique features, such as embedded editor labels and custom caret animations.
Read the following topic for more information about Advanced Mode: UseAdvancedMode.
Important
In Advanced Mode or when the WXI Skin is applied, use the Appearance.BackColor property to specify the editor’s background color. Other appearance settings that specify the background color of the editor in different states are ignored (for example, the AppearanceReadOnly.BackColor, AppearanceFocused.BackColor, AppearanceDisabled.BackColor).
if (textEdit1.Properties.ReadOnly) {
textEdit1.Properties.Appearance.BackColor = Color.LightGray;
}
If textEdit1.Properties.ReadOnly Then
textEdit1.Properties.Appearance.BackColor = Color.LightGray
End If
Show 56 items
Object MarshalByRefObject Component Control DevExpress.XtraEditors.XtraControl ControlBase BaseControl BaseEdit TextEdit ButtonEdit
ResourcesPopupCheckedListBoxControl
StorageBindedImageComboBoxEdit
See Also