TextBox.AutoCompleteSource Свойство

Определение

Пространство имен:

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Исходный код:

TextBox.cs

Возвращает или задает значение, указывающее источник полных строк, используемых для автоматического завершения.

public:
 property System::Windows::Forms::AutoCompleteSource AutoCompleteSource { System::Windows::Forms::AutoCompleteSource get(); void set(System::Windows::Forms::AutoCompleteSource value); };

[System.ComponentModel.Browsable(true)]
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.TextBoxAutoCompleteSourceConverter))]
public System.Windows.Forms.AutoCompleteSource AutoCompleteSource { get; set; }

[<System.ComponentModel.Browsable(true)>]
[<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.TextBoxAutoCompleteSourceConverter))>]
member this.AutoCompleteSource : System.Windows.Forms.AutoCompleteSource with get, set

Public Property AutoCompleteSource As AutoCompleteSource

Значение свойства

AutoCompleteSource

Одно из значений AutoCompleteSource. Параметры: AllSystemSources, AllUrl, FileSystemHistoryList, RecentlyUsedList, CustomSourceи None. Значение по умолчанию — None.

Атрибуты

BrowsableAttribute TypeConverterAttribute

Исключения

InvalidEnumArgumentException

Указанное значение не является одним из значений AutoCompleteSource.

Примеры

В следующем примере кода показано, как использовать коллекцию в качестве автоматического пользовательского источника для TextBox элемента управления. Код в примере выполняет следующие действия.

• AutoCompleteSource Использует свойство, чтобы разрешить TextBox элементу управления принимать пользовательский источник для его автоматического завершения.

• AutoCompleteCustomSource Использует свойство для задания настраиваемого списка значений.

• AutoCompleteMode Использует свойство для задания отображения кандидатов автозаполнения.

private void Form1_Load(object sender, EventArgs e)
{
    // Create the list to use as the custom source. 
    var source = new AutoCompleteStringCollection();
    source.AddRange(new string[]
                    {
                        "January",
                        "February",
                        "March",
                        "April",
                        "May",
                        "June",
                        "July",
                        "August",
                        "September",
                        "October",
                        "November",
                        "December"
                    });

    // Create and initialize the text box.
    var textBox = new TextBox
                  {
                      AutoCompleteCustomSource = source,
                      AutoCompleteMode = 
                          AutoCompleteMode.SuggestAppend,
                      AutoCompleteSource =
                          AutoCompleteSource.CustomSource,
                      Location = new Point(20, 20),
                      Width = ClientRectangle.Width - 40,
                      Visible = true
                  };

    // Add the text box to the form.
    Controls.Add(textBox);
}

Private Sub Form1_Load(ByVal sender As System.Object, _
                       ByVal e As System.EventArgs) Handles MyBase.Load

    ' Create the list to use as the custom source.
    Dim MySource As New AutoCompleteStringCollection()
    MySource.AddRange(New String() _
                        { _
                            "January", _
                            "February", _
                            "March", _
                            "April", _
                            "May", _
                            "June", _
                            "July", _
                            "August", _
                            "September", _
                            "October", _
                            "November", _
                            "December" _
                        })

    ' Create and initialize the text box.
    Dim MyTextBox As New TextBox()
    With MyTextBox
        .AutoCompleteCustomSource = MySource
        .AutoCompleteMode = AutoCompleteMode.SuggestAppend
        .AutoCompleteSource = AutoCompleteSource.CustomSource
        .Location = New Point(20, 20)
        .Width = Me.ClientRectangle.Width - 40
        .Visible = True
    End With

    ' Add the text box to the form.
    Me.Controls.Add(MyTextBox)
End Sub

Комментарии

AutoCompleteCustomSource AutoCompleteModeИспользуйте свойства и AutoCompleteSource свойства для созданияTextBox, который автоматически завершает входные строки, сравнивая префикс, введенный с префиксами всех строк в поддерживаемом источнике. Это удобно для TextBox элементов управления, в которых часто будут вводиться URL-адреса, адреса, имена файлов или команды.

Использование AutoCompleteCustomSource свойства является необязательным, но для использования AutoCompleteCustomSourceнеобходимо задать AutoCompleteSource свойствоCustomSource.

Необходимо совместно использовать AutoCompleteMode свойства и AutoCompleteSource свойства.

Замечание

AutoCompleteSource не работает над многостроными TextBox элементами управления.

Замечание

Операционная система может ограничить количество пользовательских строк, которые могут отображаться одновременно.

См. также раздел

• AutoCompleteCustomSource
• AutoCompleteMode