TextBox.AutoCompleteCustomSource Свойство

Определение

Возвращает или задает пользовательскую коллекцию StringCollection для использования в случае, когда для свойства AutoCompleteSource задано значение CustomSource.Gets or sets a custom StringCollection to use when the AutoCompleteSource property is set to CustomSource.

public:
 property System::Windows::Forms::AutoCompleteStringCollection ^ AutoCompleteCustomSource { System::Windows::Forms::AutoCompleteStringCollection ^ get(); void set(System::Windows::Forms::AutoCompleteStringCollection ^ value); };
[System.ComponentModel.Browsable(true)]
public System.Windows.Forms.AutoCompleteStringCollection AutoCompleteCustomSource { get; set; }
member this.AutoCompleteCustomSource : System.Windows.Forms.AutoCompleteStringCollection with get, set
Public Property AutoCompleteCustomSource As AutoCompleteStringCollection

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

Объект StringCollection для использования со свойством AutoCompleteSource.A StringCollection to use with AutoCompleteSource.

Атрибуты

Примеры

В следующем примере кода показано, как использовать коллекцию в качестве пользовательского источника для автоматического завершения для TextBox элемента управления.The following code example demonstrates how to use a collection as the auto-complete custom source for a TextBox control. Код в примере выполняет следующие действия.This example does the following:

  • Использует свойство, чтобы разрешить элементу управления принимать пользовательский источник для автоматического завершения. TextBox AutoCompleteSourceUses the AutoCompleteSource property to enable the TextBox control to accept a custom source for its auto-complete behavior.

  • AutoCompleteCustomSource Использует свойство для задания пользовательского списка значений.Uses the AutoCompleteCustomSource property to set the custom list of values.

  • AutoCompleteMode Использует свойство, чтобы задать способ отображения кандидатов автозавершения.Uses the AutoCompleteMode property to set how the auto-complete candidates are displayed.

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 , который автоматически завершает входные строки путем сравнения префикса, введенного для префиксов всех строк в поддерживаемом источнике.Use the AutoCompleteCustomSource, AutoCompleteMode, and AutoCompleteSource properties to create a TextBox that automatically completes input strings by comparing the prefix being entered to the prefixes of all strings in a maintained source. Это полезно для TextBox элементов управления, в которых часто записываются URL-адреса, адреса, имена файлов или команды.This is useful for TextBox controls in which URLs, addresses, file names, or commands will be frequently entered.

Использование AutoCompleteCustomSource свойства является необязательным, но для его AutoCompleteSource использования AutoCompleteCustomSourceнеобходимо установить свойство CustomSource в значение.The use of the AutoCompleteCustomSource property is optional, but you must set the AutoCompleteSource property to CustomSource in order to use AutoCompleteCustomSource.

Необходимо использовать AutoCompleteMode свойства и AutoCompleteSource вместе.You must use the AutoCompleteMode and AutoCompleteSource properties together.

Примечание

Операционная система может ограничить количество настраиваемых строк, которые могут отображаться одновременно.The operating system might limit the number of custom strings that it can display at once.

Применяется к

Дополнительно