MemoEdit Class
Allows you to display and edit multi-line text.
Namespace: DevExpress.XtraEditors
Assembly: DevExpress.XtraEditors.v24.2.dll
NuGet Package: DevExpress.Win.Navigation
#Declaration
public class MemoEdit :
TextEdit,
IAutoHeightControl,
IAutoHeightControlEx,
ISupportScrollBarColorize
#Remarks
The MemoEdit control represents an editor which allows for the display and editing of multi-line text. It provides a MemoEdit.Lines property defining the list of strings displayed. The image below shows a sample memo editor.
You can use the RepositoryItemMemoEdit.WordWrap property to specify whether long strings, which do not contain any return characters, are wrapped automatically at the right edge of a memo edit control. To determine whether scroll bars should be displayed in a memo editor, use the RepositoryItemMemoEdit.ScrollBars property.
The RepositoryItemMemoEdit.AcceptsReturn and RepositoryItemMemoEdit.AcceptsTab properties define how a memo editor interprets ENTER and TAB key presses by the user. If a memo editor accepts returns (RepositoryItemMemoEdit.AcceptsReturn is true), inserting carriage-return/linefeed characters creates a new text line within the editor; otherwise, return key presses are processed by the form. Tabs can be used either to align text within the memo editor or move focus to another control.
Use the MemoEdit.Properties and RepositoryItem.LookAndFeel members to specify the behavior and look & feel of a memo editor.
The editor does not support editing in masked mode, therefore RepositoryItemTextEdit.MaskSettings object settings are not in effect.
#Tooltips
DevExpress controls support regular and super tooltips. Enable the ShowToolTips option to display tooltips when the mouse pointer hovers over the control.
Customize Regular Tooltip Text
Use the following properties of the target control to specify regular tooltip text and title:
API | Description |
---|---|
Specifies tooltip text. You can use line breaks in regular tooltips. | |
Specifies whether to parse HTML tags in text. | |
Specifies the tooltip title. If you do not specify tooltip text, the tooltip is not displayed even if you specify the title. |
The following code snippet specifies tooltip text and title for a TextEdit
editor:
public Form1() {
InitializeComponent();
textEdit1.ShowToolTips = true;
textEdit1.ToolTipTitle = "Name";
textEdit1.ToolTip = "Please enter your name";
}
Assign an Image to Regular Tooltips
Use the control’s ToolTipIconType property to assign a predefined icon. The ToolTipController.IconSize property specifies icon size.
Assign a custom image as follows:
- Create a ToolTipController and assign it to the control’s ToolTipController property.
- Create an image collection and assign it to the ToolTipController.ImageList property.
- Handle the ToolTipController.BeforeShow event. Use the e.ImageOptions parameter to assign a raster or vector image to the tooltip.
Note
The Tool
property has priority over e.
. If you assign a custom image, set Tool
to None
.
The following code snippet assigns a custom image to the TextEdit
tooltip:
Note
text
, tool
, and svg
were created at runtime.
public Form1() {
InitializeComponent();
textEdit1.ShowToolTips = true;
textEdit1.ToolTipTitle = "Name";
textEdit1.ToolTip = "Please enter your name";
textEdit1.ToolTipController = toolTipController1;
toolTipController1.ImageList = svgImageCollection1;
toolTipController1.BeforeShow += ToolTipController1_BeforeShow;
}
private void ToolTipController1_BeforeShow(object sender, ToolTipControllerShowEventArgs e) {
ToolTipController controller = sender as ToolTipController;
if (e.ToolTip == textEdit1.ToolTip)
e.ImageOptions.SvgImage = (controller.ImageList as SvgImageCollection)["personalCard"];
}
Display a Super Tooltip
Use the control’s SuperTip property to assign a super tooltip. If you wish to use HTML tags in a super tooltip, enable the SuperToolTip.AllowHtmlText property.
Setting the ToolTipController.ToolTipType property to SuperTip converts existing regular tooltips to super tooltips.
Tip
Read the following help topic for information on how to customize super tooltips: Hints and Tooltips.