ToolBar.ToolBarButtonCollection.Add Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Adds a new toolbar button to the end of the toolbar button collection.

Overloads

Add(String)	Adds a new toolbar button to the end of the toolbar button collection with the specified Text property value.
Add(ToolBarButton)	Adds the specified toolbar button to the end of the toolbar button collection.

Add(String)

Adds a new toolbar button to the end of the toolbar button collection with the specified Text property value.

public:
 int Add(System::String ^ text);

public int Add (string text);

member this.Add : string -> int

Public Function Add (text As String) As Integer

Parameters

text

String

The text to display on the new ToolBarButton.

Returns

Int32

The zero-based index value of the ToolBarButton added to the collection.

Examples

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.

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 = gcnew ToolBarButton( "tbb1" );
      ToolBarButton^ tbb2 = gcnew ToolBarButton( "tbb2" );
      ToolBarButton^ tbb3 = gcnew ToolBarButton( "tbb3" );
      
      // Add toolbar buttons to the toolbar.
      array<ToolBarButton^>^buttons = {tbb2,tbb3};
      toolBar->Buttons->AddRange( buttons );
      toolBar->Buttons->Add( "tbb4" );
      
      // Insert tbb1 into the first position in the collection.
      toolBar->Buttons->Insert( 0, tbb1 );
   }
}

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);
   }
}

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

Remarks

You can also add new ToolBarButton objects to the collection by using the AddRange or Insert methods, or the other version of the Add method.

To remove a ToolBarButton that you have previously added, use the Remove, RemoveAt or Clear methods.

See also

• Remove(ToolBarButton)
• Clear()

Add(ToolBarButton)

Adds the specified toolbar button to the end of the toolbar button collection.

public:
 int Add(System::Windows::Forms::ToolBarButton ^ button);

public int Add (System.Windows.Forms.ToolBarButton button);

member this.Add : System.Windows.Forms.ToolBarButton -> int

Public Function Add (button As ToolBarButton) As Integer

Parameters

button

ToolBarButton

The ToolBarButton to be added after all existing buttons.

Returns

Int32

The zero-based index value of the ToolBarButton added to the collection.

Examples

The following code example adds a new ToolBarButton control to an existing ToolBar with existing buttons. The toolbar button will be added to the end of the ToolBar.Buttons collection.

public:
   void AddMyButton()
   {
      ToolBarButton^ toolBarButton1 = gcnew ToolBarButton;
      toolBarButton1->Text = "Print";
      
      // Add the new toolbar button to the toolbar.
      toolBar1->Buttons->Add( toolBarButton1 );
   }

public void AddMyButton()
 {
    ToolBarButton toolBarButton1 = new ToolBarButton();
    toolBarButton1.Text = "Print";
 
    // Add the new toolbar button to the toolbar.
    toolBar1.Buttons.Add(toolBarButton1);
 }

Public Sub AddMyButton()
    Dim toolBarButton1 As New ToolBarButton()
    toolBarButton1.Text = "Print"
    
    ' Add the new toolbar button to the toolbar.
    toolBar1.Buttons.Add(toolBarButton1)
End Sub

Remarks

You can also add new ToolBarButton objects to the collection by using the AddRange or Insert methods, or the other version of the Add method.

To remove a ToolBarButton that you have previously added, use the Remove, RemoveAt or Clear methods.

See also

• Remove(ToolBarButton)
• Clear()