This documentation is archived and is not being maintained.

ToolBar.ToolBarButtonCollection.Remove Method

Removes a given button from the toolbar button collection.

[Visual Basic]
Public Sub Remove( _
   ByVal button As ToolBarButton _
)
[C#]
public void Remove(
 ToolBarButton button
);
[C++]
public: void Remove(
 ToolBarButton* button
);
[JScript]
public function Remove(
   button : ToolBarButton
);

Parameters

button
The ToolBarButton to remove from the collection.

Remarks

To remove toolbar buttons from the collection, use the RemoveAt, or Clear methods.

To add new ToolBarButton objects to the collection, use the Add, AddRange or Insert methods.

Example

[Visual Basic, C#, C++] The following 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 assumes you have a Form with a ToolBar control on it.

[Visual Basic] 
Private Sub AddToolbarButtons(toolBar As ToolBar)
   If Not toolBar.Buttons.IsReadOnly Then
      ' If toolBarButton1 in in the collection, remove it.
      If toolBar.Buttons.Contains(toolBarButton1) Then
         toolBar.Buttons.Remove(toolBarButton1)
      End If

      ' Create three toolbar buttons.
      Dim tbb1 As New ToolBarButton("tbb1")
      Dim tbb2 As New ToolBarButton("tbb2")
      Dim tbb3 As 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)
   End If
End Sub

[C#] 
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);
   }
}

[C++] 
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(S"tbb1");
            ToolBarButton* tbb2 = new ToolBarButton(S"tbb2");
            ToolBarButton* tbb3 = new ToolBarButton(S"tbb3");

            // Add toolbar buttons to the toolbar.
            ToolBarButton* buttons[] = {tbb2, tbb3};
            toolBar->Buttons->AddRange(buttons);
            toolBar->Buttons->Add(S"tbb4");

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

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

ToolBar.ToolBarButtonCollection Class | ToolBar.ToolBarButtonCollection Members | System.Windows.Forms Namespace | Clear | ToolBarButton | Add

Show: