Export (0) Print
Expand All

ToolBar.ToolBarButtonCollection.Add Method (String)

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

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

public int Add(
	string text
)

Parameters

text
Type: System.String
The text to display on the new ToolBarButton.

Return Value

Type: System.Int32
The zero-based index value of the ToolBarButton added to the collection.

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.

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

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft