ImageList.ImageCollection.IndexOfKey(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Determines the index of the first occurrence of an image with the specified key in the collection.
public:
int IndexOfKey(System::String ^ key);
public int IndexOfKey (string key);
member this.IndexOfKey : string -> int
Public Function IndexOfKey (key As String) As Integer
Parameters
- key
- String
The key of the image to retrieve the index for.
Returns
The zero-based index of the first occurrence of an image with the specified key in the collection, if found; otherwise, -1.
Remarks
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.