ToolBar.ToolBarButtonCollection.IndexOfKey(String) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

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.

Retrieves the index of the first occurrence of a ToolBarButton with the specified key.

public:
 virtual int IndexOfKey(System::String ^ key);

public virtual int IndexOfKey(string key);

abstract member IndexOfKey : string -> int
override this.IndexOfKey : string -> int

Public Overridable Function IndexOfKey (key As String) As Integer

Parameters

key: String

The name of the ToolBarButton to search for.

Returns

Int32

The index of the first occurrence of a ToolBarButton 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 ToolBarButton in the ToolBar.ToolBarButtonCollection.

The key comparison is not case-sensitive. If the key parameter is null or an empty string, Item[] 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, 10

Share via