Export (0) Print
Expand All

ToolBar.ToolBarButtonCollection Class

Encapsulates a collection of ToolBarButton controls for use by the ToolBar class.

System.Object
  System.Windows.Forms.ToolBar.ToolBarButtonCollection

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

public class ToolBarButtonCollection : IList, 
	ICollection, IEnumerable

The ToolBar.ToolBarButtonCollection type exposes the following members.

  NameDescription
Public methodToolBar.ToolBarButtonCollectionInitializes a new instance of the ToolBar.ToolBarButtonCollection class and assigns it to the specified toolbar.
Top

  NameDescription
Public propertyCountGets the number of buttons in the toolbar button collection.
Public propertyIsReadOnlyGets a value indicating whether the collection is read-only.
Public propertyItem[Int32]Gets or sets the toolbar button at the specified indexed location in the toolbar button collection.
Public propertyItem[String]Gets a ToolBarButton with the specified key from the collection.
Top

  NameDescription
Public methodAdd(String)Adds a new toolbar button to the end of the toolbar button collection with the specified ToolBarButton.Text property value.
Public methodAdd(ToolBarButton)Adds the specified toolbar button to the end of the toolbar button collection.
Public methodAddRangeAdds a collection of toolbar buttons to this toolbar button collection.
Public methodClearRemoves all buttons from the toolbar button collection.
Public methodContainsDetermines if the specified toolbar button is a member of the collection.
Public methodContainsKeyDetermines if a ToolBarButton with the specified key is contained in the collection.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that can be used to iterate through the toolbar button collection.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfRetrieves the index of the specified toolbar button in the collection.
Public methodIndexOfKeyRetrieves the index of the first occurrence of a ToolBarButton with the specified key.
Public methodInsertInserts an existing toolbar button in the toolbar button collection at the specified location.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveRemoves a given button from the toolbar button collection.
Public methodRemoveAtRemoves a given button from the toolbar button collection.
Public methodRemoveByKeyRemoves the ToolBarButton with the specified key from the collection.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodCast<TResult>Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToInfrastructure. Copies the elements of the ICollection to an Array, starting at a particular Array index.
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedInfrastructure. Gets a value indicating whether access to the collection is synchronized (thread safe).
Explicit interface implemetationPrivate propertyICollection.SyncRootInfrastructure. Gets an object that can be used to synchronize access to the collection of buttons.
Explicit interface implemetationPrivate methodIList.AddInfrastructure. Adds the specified toolbar button to the end of the toolbar button collection.
Explicit interface implemetationPrivate methodIList.ContainsInfrastructure. Determines whether the collection contains a specific value.
Explicit interface implemetationPrivate methodIList.IndexOfInfrastructure. Determines the index of a specific item in the collection.
Explicit interface implemetationPrivate methodIList.InsertInfrastructure. Inserts an existing toolbar button in the toolbar button collection at the specified location.
Explicit interface implemetationPrivate propertyIList.IsFixedSizeInfrastructure. Gets a value indicating whether the collection has a fixed size.
Explicit interface implemetationPrivate propertyIList.ItemInfrastructure. Gets or sets the item at a specified index.
Explicit interface implemetationPrivate methodIList.RemoveInfrastructure. Removes the first occurrence of an item from the collection.
Top

The ToolBar.ToolBarButtonCollection is a zero-based indexed collection used by the ToolBar class to hold all the ToolBarButton controls assigned to the toolbar. Use the Add method to add individual buttons and the Remove method to delete them. Call the Clear method to remove all the buttons from the collection.

The following code example creates and initializes a ToolBar and three ToolBarButton controls. The toolbar buttons are assigned to the toolbar and the toolbar is added to the form. This code requires that a Form has already been created.

public void InitializeMyToolBar()
 {
    // Create and initialize the ToolBarButton controls and ToolBar.
    ToolBar toolBar1 = new ToolBar();
    ToolBarButton toolBarButton1 = new ToolBarButton();
    ToolBarButton toolBarButton2 = new ToolBarButton();
    ToolBarButton toolBarButton3 = new ToolBarButton();

    // Set the Text properties of the ToolBarButton controls.
    toolBarButton1.Text = "Open";
    toolBarButton2.Text = "Save";
    toolBarButton3.Text = "Print";

    // Add the ToolBarButton controls to the ToolBar.
    toolBar1.Buttons.Add(toolBarButton1);
    toolBar1.Buttons.Add(toolBarButton2);
    toolBar1.Buttons.Add(toolBarButton3);

    // Add the ToolBar to the Form.
    Controls.Add(toolBar1);
 }

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft