TextEditAdvancedModeOptions.AutoCompleteCustomSource Property

Gets or sets a custom collection of autocomplete suggestions. This property is in effect in advanced mode when the AutoCompleteSource option is set to CustomSource.

Namespace : DevExpress.XtraEditors

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

csharp

[DXCategory("Behavior")]
public virtual AutoCompleteStringCollection AutoCompleteCustomSource { get; set; }

<DXCategory("Behavior")>
Public Overridable Property AutoCompleteCustomSource As AutoCompleteStringCollection

Property Value

Type	Description
AutoCompleteStringCollection

The TextEdit’s custom string collection source.

Property Paths

You can access this nested property as listed below:

Object Type	Path to AutoCompleteCustomSource
RepositoryItemTextEdit

.AdvancedModeOptions .AutoCompleteCustomSource

Remarks

To supply custom autocomplete suggestions to the editor, set the AutoCompleteSource property to CustomSource , and populate the AutoCompleteCustomSource collection with the suggestions. You can also handle the RepositoryItemTextEdit.CustomizeAutoCompleteSource event to supply custom autocomplete suggestions dynamically.

A text editor automatically sets the AutoCompleteSource property to CustomSource when you set the TextEditAdvancedModeOptions.AutoCompleteMode option to SuggestSingleWord.

Example

The example below uses the TextEditAdvancedModeOptions.AutoCompleteCustomSource property to supply custom auto-complete suggestions for a text editor.

C#
VB.NET

csharp

private void Form1_Load(object sender, EventArgs e) {
    // Define a custom string collection.
    var DaysOfTheWeek = new AutoCompleteStringCollection();
    DaysOfTheWeek.AddRange(new string[]
      {"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"});

    // Activate advanced mode.
    textEdit1.Properties.UseAdvancedMode = DevExpress.Utils.DefaultBoolean.True;
    textEdit1.Properties.AdvancedModeOptions.AutoCompleteMode = DevExpress.XtraEditors.TextEditAutoCompleteMode.SuggestAppend;
    // Enable custom auto-complete suggestions.
    textEdit1.Properties.AdvancedModeOptions.AutoCompleteSource = AutoCompleteSource.CustomSource;
    // Supply the custom auto-complete suggestions.
    textEdit1.Properties.AdvancedModeOptions.AutoCompleteCustomSource = DaysOfTheWeek;
  }

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
    ' Define a custom string collection.
    Dim DaysOfTheWeek As var = New AutoCompleteStringCollection() 
    Dim String() As DaysOfTheWeek.AddRange(New
      {"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"})

    ' Activate advanced mode.
    textEdit1.Properties.UseAdvancedMode = DevExpress.Utils.DefaultBoolean.True
    textEdit1.Properties.AdvancedModeOptions.AutoCompleteMode = DevExpress.XtraEditors.TextEditAutoCompleteMode.SuggestAppend
    ' Enable custom auto-complete suggestions.
    textEdit1.Properties.AdvancedModeOptions.AutoCompleteSource = AutoCompleteSource.CustomSource
    ' Supply the custom auto-complete suggestions.
    textEdit1.Properties.AdvancedModeOptions.AutoCompleteCustomSource = DaysOfTheWeek
  End Sub