TextBox::AutoCompleteSource Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a value specifying the source of complete strings used for automatic completion.

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

public:
[BrowsableAttribute(true)]
property AutoCompleteSource AutoCompleteSource {
	AutoCompleteSource get();
	void set(AutoCompleteSource value);
}

Property Value

Type: System.Windows.Forms::AutoCompleteSource

One of the values of AutoCompleteSource. The options are AllSystemSources, AllUrl, FileSystem, HistoryList, RecentlyUsedList, CustomSource, and None. The default is None.

Exception Condition
InvalidEnumArgumentException

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

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.

System_CAPS_noteNote

AutoCompleteSource does not work on multiline TextBox controls.

System_CAPS_noteNote

The operating system might limit the number of custom strings that can be displayed 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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: