ToolBar::ToolBarButtonCollection::Item Property (Int32)

 

Gets or sets the toolbar button at the specified indexed location in the toolbar button collection.

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

public:
property ToolBarButton^ default[
	int index
] {
	virtual ToolBarButton^ get(int index);
	virtual void set(int index, ToolBarButton^ value);
}

Parameters

index
Type: System::Int32

The indexed location of the ToolBarButton in the collection.

Property Value

Type: System.Windows.Forms::ToolBarButton^

A ToolBarButton that represents the toolbar button at the specified indexed location.

Exception Condition
ArgumentNullException

The index value is null.

ArgumentOutOfRangeException

The index value is less than zero.

-or-

The index value is greater than the number of buttons in the collection, and the collection of buttons is not null.

To assign ToolBarButton controls to a specific location, or to retrieve them from the ToolBar::ToolBarButtonCollection, you can reference the collection object with a specific index value. The index value of the ToolBar::ToolBarButtonCollection is a zero-based index.

The following code example replaces the last toolbar button on a toolbar. This code requires that a ToolBar and at least one ToolBarButton have been created. The example gets the number of buttons on the toolbar and replaces the last button with a newly created one. The index value of the toolbar button being replaced is set to the Count property, minus one, since the ToolBarButton collection is a zero-based index.

void ReplaceMyToolBarButton()
{
   int btns;
   btns = toolBar1->Buttons->Count;
   ToolBarButton^ toolBarButton1 = gcnew ToolBarButton;
   toolBarButton1->Text = "myButton";

   // Replace the last ToolBarButton in the collection.
   toolBar1->Buttons[ btns - 1 ] = toolBarButton1;
}

.NET Framework
Available since 1.1
Return to top
Show: