Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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 virtual ToolBarButton this[
	int index
] { get; set; }

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.
ExceptionCondition
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.


public void ReplaceMyToolBarButton()
 {
    int btns;
    btns = toolBar1.Buttons.Count;
    ToolBarButton toolBarButton1 = new ToolBarButton();
    toolBarButton1.Text = "myButton";

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


.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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.