ComboBox.AutoCompleteSource Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

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

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

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

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

Public Property AutoCompleteSource As AutoCompleteSource

Property Value

AutoCompleteSource

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

Attributes

BrowsableAttribute

Exceptions

InvalidEnumArgumentException

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

Remarks

Use the AutoCompleteCustomSource, AutoCompleteMode, and AutoCompleteSource properties to create a ComboBox 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 ComboBox 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.

With AutoCompleteMode set to SuggestAppend and AutoCompleteSource set to ListItems, the behavior is as follows:

• If the list of strings is empty, pressing the BACKSPACE or DELETE key does nothing.

• If the BACKSPACE key is pressed in less than one second, the previous item is selected, or nothing is selected if the list of string is empty.

• If the BACKSPACE key is pressed in more than one second, the first item is selected.

• If the DELETE key is pressed, the first item is selected.

Note

The operating system might limit the number of custom strings that it can display at once. For strings that contain a forward slash (/) or backward slash (\), automatic completion appends all characters only up to and including the slash.

See also

• AutoCompleteCustomSource
• AutoCompleteMode