ToolBar.ToolBarButtonCollection.Contains Method (ToolBarButton)

 
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.

Determines if the specified toolbar button is a member of the collection.

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

public bool Contains(
	ToolBarButton button
)

Parameters

button
Type: System.Windows.Forms.ToolBarButton

The ToolBarButton to locate in the collection.

Return Value

Type: System.Boolean

true if the ToolBarButton is a member of the collection; otherwise, false.

This method enables you to determine whether a ToolBarButton is member of the collection before attempting to perform operations on the ToolBarButton. You can use this method to confirm that a ToolBarButton has been added to or is still a member of the collection.

The following code example removes an existing ToolBarButton from a ToolBar control if it exists and adds and inserts four new ToolBarButton objects to the ToolBar. This example requires that you have a Form with a ToolBar control on it.

private void AddToolbarButtons(ToolBar toolBar)
{
   if(!toolBar.Buttons.IsReadOnly)
   {
      // If toolBarButton1 in in the collection, remove it.
      if(toolBar.Buttons.Contains(toolBarButton1))
      {
         toolBar.Buttons.Remove(toolBarButton1);
      }

      // Create three toolbar buttons.
      ToolBarButton tbb1 = new ToolBarButton("tbb1");
      ToolBarButton tbb2 = new ToolBarButton("tbb2");
      ToolBarButton tbb3 = new ToolBarButton("tbb3");

      // Add toolbar buttons to the toolbar.		
      toolBar.Buttons.AddRange(new ToolBarButton[] {tbb2, tbb3});
      toolBar.Buttons.Add("tbb4");

      // Insert tbb1 into the first position in the collection.
      toolBar.Buttons.Insert(0, tbb1);
   }
}

.NET Framework
Available since 1.1
Return to top
Show: