TextEdit Class

The single-line text editor.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v21.1.dll

Declaration

[DefaultBindingPropertyEx("Text")]
public class TextEdit :
    BaseEdit,
    ITextEditControllerProvider,
    IDXMenuSupport,
    IMouseWheelSupport,
    ISupportsBaselineAlignment

The following members accept/return TextEdit objects:

Remarks

The TextEdit.Properties property allows access to the RepositoryItemTextEdit object - a repository item that stores editor settings.

The image below shows a sample text edit.

TextEdit

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

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.

Advanced Mode

All editors derived from the TextEdit class (except for TokenEdit, 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.

embedded labels

See these links for more information about Advanced Mode:

Tooltips

DevExpress controls support regular and super tooltips. If the ShowToolTips option is enabled, tooltips are shown when the mouse pointer hovers the control.

Use the following properties to specify a regular tooltip’s content:

  • ToolTip — a regular tooltip’s text. If the text is not specified, the tooltip is not displayed even if the title is specified. You can use line breaks in regular tooltips. Use the AllowHtmlTextInToolTip property to specify whether to parse HTML tags in the text. HTML tags allow you to format the text: size, style, hyperlinks, etc.
  • ToolTipTitle — a regular tooltip’s title. If the title is not specified, it is not displayed.
  • ToolTipIconType — a regular tooltip’s predefined icon. Use the controller’s IconSize property to specify the image size.

    To display a custom image in all regular tooltips, use the controller’s ImageList and ImageIndex properties.

    To display a custom image in a particular regular tooltip, handle the BeforeShow event. Use the ImageOptions event argument to assign a raster or vector image to the processed tooltip.

To assign a super tooltip to a control, use the SuperTip property. Enable the AllowHtmlText property to use HTML tags in the super tooltip.

To replace regular tooltips with super tooltips, set the ToolTipController.ToolTipType property to SuperTip. The controller automatically converts regular tooltips to super tooltips. To access this property, you can use the DefaultToolTipController component or a custom controller assigned to the ToolTipController property. See Tooltips for more information.

See Also