ComboBox.FindStringExact Method (String, Int32)

 
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.

Finds the first item after the specified index that matches the specified string.

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

member FindStringExact : 
        s:string *
        startIndex:int -> int

Parameters

s
Type: System.String

The String to search for.

startIndex
Type: System.Int32

The zero-based index of the item before the first item to be searched. Set to -1 to search from the beginning of the control.

Return Value

Type: System.Int32

The zero-based index of the first item found; returns -1 if no match is found, or 0 if the s parameter specifies Empty.

Exception Condition
ArgumentOutOfRangeException

The startIndex is less than -1.

-or-

The startIndex is equal to the last index in the collection.

The search performed by this method is not case-sensitive. The s parameter is a string to compare against the text associated with the items in the combo box list. The search looks for a match starting from the beginning of the text, returning the first item in the list that matches the specified substring. You can then perform tasks, such as removing the item that contains the search text using the Remove method or changing the item's text. This method is typically used after a call has been made using the version of this method that does not specify a starting index. Once an initial item has been found in the list, this method is typically used to find further instances of the search text by specifying the index position in the startIndex parameter of the item after the first found instance of the search text. If you want to perform partial word search instead of an exact word match, use the FindString method.

The search performed by this method is circular. Although the search starts at the next index after the startIndex parameter, the search restarts at 0 when the end of the collection is reached. However, note that if the startIndex parameter itself is equal to the last index in the collection, an exception is thrown.

The following code example demonstrates how to initialize a ComboBox control by setting the MaxDropDownItems and DropDownStyle properties and using the FindStringExact methods to search the ComboBox. It also shows handling the SelectedIndexChanged event.

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

.NET Framework
Available since 1.1
Return to top
Show: