RepositoryItemLookUpEdit.TextEditStyle Property

Gets or sets a value that specifies whether users can type in the lookup’s text box.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Behavior")]
public override TextEditStyles TextEditStyle { get; set; }

VB.NET

<DXCategory("Behavior")>
Public Overrides Property TextEditStyle As TextEditStyles

Property Value

Type	Description
TextEditStyles	A TextEditStyles enumeration value.

Available values:

Name	Description
Standard	A button editor works in its normal way. Editing and selecting text is allowed.
HideTextEditor	The text editing region is not visible and the editor displays only buttons contained in the current button editor. If no buttons can be displayed (for instance because of setting the EditorButton.Visible property to False), the editor displays an empty region in this case.
DisableTextEditor	A button editor is displayed in its normal way. However, editing and selecting text is not allowed. If you want to enable a user to select text but disable text modifications, you can set the text editing style to Standard and set the RepositoryItem.ReadOnly property to true.

Remarks

Set the TextEditStyle property to TextEditStyles.Standard to allow users to type in the text box. Handle the ProcessNewValue event to parse entered values and add new records to the lookup’s data source.

C#

// Enables adding new values.
lookUpEdit1.Properties.TextEditStyle = TextEditStyles.Standard;
lookUpEdit1.ProcessNewValue += new ProcessNewValueEventHandler(
    this.lookUpEdit1_ProcessNewValue
);

private void lookUpEdit1_ProcessNewValue(object sender, ProcessNewValueEventArgs e) {
    if((string)e.DisplayValue == String.Empty) return;
    List<Task> dataSource = (sender as LookUpEdit).Properties.DataSource as List<Task>;
    dataSource.Add(new Task(dataSource.Count) { Caption = (string)e.DisplayValue});
    e.Handled = true;
}

VB.NET

' Enables adding new values.
lookUpEdit1.Properties.TextEditStyle = TextEditStyles.Standard
AddHandler lookUpEdit1.ProcessNewValue, AddressOf lookUpEdit1_ProcessNewValue

Private Sub lookUpEdit1_ProcessNewValue(ByVal sender As Object, ByVal e As ProcessNewValueEventArgs)
    If CStr(e.DisplayValue) = String.Empty Then
        Return
    End If
    Dim dataSource As List(Of Task) = TryCast((TryCast(sender, LookUpEdit)).Properties.DataSource, List(Of Task))
    dataSource.Add(New Task(dataSource.Count) With {.Caption = CStr(e.DisplayValue)})
    e.Handled = True
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the TextEditStyle 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-use-the-processnewvalue-event-of-a-lookup-editor-e285/CS/Form1.cs#L39

    LookUpEdit1.Properties.SearchMode = DevExpress.XtraEditors.Controls.SearchMode.OnlyInPopup;
    LookUpEdit1.Properties.TextEditStyle = DevExpress.XtraEditors.Controls.TextEditStyles.Standard;
}

winforms-data-lookups-combobox-mode/CS/Lookup-ComboboxMode/Form1.cs#L33

lookUpEdit1.Properties.DataSource = colors;
lookUpEdit1.Properties.TextEditStyle = DevExpress.XtraEditors.Controls.TextEditStyles.Standard;
lookUpEdit1.Properties.AcceptEditorTextAsNewValue = DevExpress.Utils.DefaultBoolean.Default; //Default is equivalent to True for LookupEdit control

winforms-dashboard-custom-properties/CS/WinForms-Dashboard-Custom-Properties/Modules/ConstantLineUserValueModule.cs#L143

var lookUpEdit = ri as RepositoryItemLookUpEdit;
lookUpEdit.TextEditStyle = TextEditStyles.DisableTextEditor;
lookUpEdit.AllowNullInput = DefaultBoolean.False;

VB.NET

how-to-use-the-processnewvalue-event-of-a-lookup-editor-e285/VB/Form1.vb#L40

    LookUpEdit1.Properties.SearchMode = DevExpress.XtraEditors.Controls.SearchMode.OnlyInPopup
    LookUpEdit1.Properties.TextEditStyle = DevExpress.XtraEditors.Controls.TextEditStyles.Standard
End Sub

winforms-data-lookups-combobox-mode/VB/Lookup-ComboboxMode/Form1.vb#L27

lookUpEdit1.Properties.DataSource = colors
lookUpEdit1.Properties.TextEditStyle = DevExpress.XtraEditors.Controls.TextEditStyles.Standard
lookUpEdit1.Properties.AcceptEditorTextAsNewValue = DevExpress.Utils.DefaultBoolean.Default 'Default is equivalent to True for LookupEdit control

winforms-dashboard-custom-properties/VB/WinForms-Dashboard-Custom-Properties/Modules/ConstantLineUserValueModule.vb#L152

Dim lookUpEdit = TryCast(ri, RepositoryItemLookUpEdit)
lookUpEdit.TextEditStyle = TextEditStyles.DisableTextEditor
lookUpEdit.AllowNullInput = DefaultBoolean.False