ImageList::ImageCollection::IndexOfKey Method (String^)

 

Determines the index of the first occurrence of an image with the specified key in the collection.

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

public:
int IndexOfKey(
	String^ key
)

Parameters

key
Type: System::String^

The key of the image to retrieve the index for.

Return Value

Type: System::Int32

The zero-based index of the first occurrence of an image with the specified key in the collection, if found; otherwise, -1.

If IndexOfKey is called successively, the last returned index will be checked for a key match first, and if there is no match, the search starts at the beginning of the collection.

The name of an image corresponds to its key in the ImageList::ImageCollection. The key comparison is not case-sensitive. If the key parameter is null or an empty string, the IndexOfKey method returns -1.

.NET Framework
Available since 2.0
Return to top
Show: