Export (0) Print
Expand All

TextBox.AutoCompleteMode Property

Gets or sets an option that controls how automatic completion works for the TextBox.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

[BrowsableAttribute(true)]
public AutoCompleteMode AutoCompleteMode { get; set; }

Property Value

Type: System.Windows.Forms.AutoCompleteMode
One of the values of AutoCompleteMode. The following are the values.
Append

Appends the remainder of the most likely candidate string to the existing characters, highlighting the appended characters.

Suggest

Displays the auxiliary drop-down list associated with the edit control. This drop-down is populated with one or more suggested completion strings.

SuggestAppend

Appends both Suggest and Append options.

None

Disables automatic completion. This is the default.


ExceptionCondition
InvalidEnumArgumentException

The specified value is not one of the values of AutoCompleteMode.

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. This is useful for TextBox controls in which URLs, addresses, file names, or commands will be frequently entered.

The use of the AutoCompleteCustomSource property is optional, but you must set the AutoCompleteSource property to CustomSource in order to use AutoCompleteCustomSource.

You must use the AutoCompleteMode and AutoCompleteSource properties together.

NoteNote

The operating system might limit the number of custom strings that it can display at once.

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:

  • Uses the AutoCompleteSource property to enable the TextBox control to accept a custom source for its auto-complete behavior.

  • Uses the AutoCompleteCustomSource property to set the custom list of values.

  • 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);
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft