TabControl.TabPageCollection.IndexOfKey(String) Method

Definition

Returns the index of the first occurrence of the TabPage with the specified key.

C#
public virtual int IndexOfKey (string key);
C#
public virtual int IndexOfKey (string? key);

Parameters

key
String

The name of the tab page to find in the collection.

Returns

The zero-based index of the first occurrence of a tab page with the specified key, 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 property corresponds to the key for a TabPage in the TabControl.TabPageCollection. The key comparison is not case-sensitive. If the key parameter is null or an empty string, IndexOfKey returns -1.

Applies to

Product Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9