ToolBar::ToolBarButtonCollection::Insert Method (Int32, ToolBarButton^)

 

Inserts an existing toolbar button in the toolbar button collection at the specified location.

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

public:
void Insert(
	int index,
	ToolBarButton^ button
)

Parameters

index
Type: System::Int32

The indexed location within the collection to insert the toolbar button.

button
Type: System.Windows.Forms::ToolBarButton^

The ToolBarButton to insert.

You can also add new ToolBarButton objects to the collection by using the Add or AddRange methods.

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.

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

.NET Framework
Available since 1.1
Return to top
Show: