TextEdit.MaskBox Property

Gets the text box that provides text editing functionality.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[Browsable(false)]
public virtual TextBoxMaskBox MaskBox { get; }

VB.NET

<Browsable(False)>
Public Overridable ReadOnly Property MaskBox As TextBoxMaskBox

Property Value

Type	Description
DevExpress.XtraEditors.TextBoxMaskBox	A DevExpress.XtraEditors.TextBoxMaskBox object that represents the editor’s text box.

Remarks

Text editors in the XtraEditors library are represented by the TextEdit class and its descendants. Internally, each DevExpress text editor owns a text box that implements the text input functionality. A text editor, which is a wrapper for a text box, adds additional elements to the text box (borders and buttons).

The MaskBox property allows you to get an editor’s text box.

The text box is represented by the DevExpress.XtraEditors.TextBoxMaskBox class, which is the TextBox control’s descendant. Typically, you do need to work with DevExpress.XtraEditors.TextBoxMaskBox controls directly. In specific cases, however, this control can be retrieved by certain functions; for example, when a text editor is focused, the form’s ActiveControl property will return the editor’s text box (a DevExpress.XtraEditors.TextBoxMaskBox object) rather than the editor itself. To get the editor, read the text box’s Parent property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the MaskBox property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-insert-a-text-into-the-memoedit-at-the-drop-position-e2963/CS/MemoEditDragDropInsertText/Form1.cs#L42

TextEdit editor = (TextEdit)sender;
TextBox textBox = editor.MaskBox;
string text = (string)e.Data.GetData(typeof(string));

how-to-use-the-showcaret-hidecaret-functions-with-the-textedit-e2051/CS/Q248138/Form1.cs#L12

private bool IsMaskBoxAvailable(TextEdit editor) {
    return editor.MaskBox != null && editor.MaskBox.Visible && editor.MaskBox.IsHandleCreated;
}

VB.NET

how-to-insert-a-text-into-the-memoedit-at-the-drop-position-e2963/VB/MemoEditDragDropInsertText/Form1.vb#L48

Dim editor As TextEdit = CType(sender, TextEdit)
Dim textBox As TextBox = editor.MaskBox
Dim text As String = CStr(e.Data.GetData(GetType(String)))

how-to-use-the-showcaret-hidecaret-functions-with-the-textedit-e2051/VB/Q248138/Form1.vb#L14

Private Function IsMaskBoxAvailable(ByVal editor As TextEdit) As Boolean
    Return editor.MaskBox IsNot Nothing AndAlso editor.MaskBox.Visible AndAlso editor.MaskBox.IsHandleCreated
End Function