This topic has not yet been rated - Rate this topic

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.

  Name Description
Public method ToolBar.ToolBarButtonCollection Initializes a new instance of the ToolBar.ToolBarButtonCollection class and assigns it to the specified toolbar.
Top
  Name Description
Public property Count Gets the number of buttons in the toolbar button collection.
Public property IsReadOnly Gets a value indicating whether the collection is read-only.
Public property Item[Int32] Gets or sets the toolbar button at the specified indexed location in the toolbar button collection.
Public property Item[String] Gets a ToolBarButton with the specified key from the collection.
Top
  Name Description
Public method Add(String) Adds a new toolbar button to the end of the toolbar button collection with the specified ToolBarButton.Text property value.
Public method Add(ToolBarButton) Adds the specified toolbar button to the end of the toolbar button collection.
Public method AddRange Adds a collection of toolbar buttons to this toolbar button collection.
Public method Clear Removes all buttons from the toolbar button collection.
Public method Contains Determines if the specified toolbar button is a member of the collection.
Public method ContainsKey Determines if a ToolBarButton with the specified key is contained in the collection.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an enumerator that can be used to iterate through the toolbar button collection.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Retrieves the index of the specified toolbar button in the collection.
Public method IndexOfKey Retrieves the index of the first occurrence of a ToolBarButton with the specified key.
Public method Insert Inserts an existing toolbar button in the toolbar button collection at the specified location.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Remove Removes a given button from the toolbar button collection.
Public method RemoveAt Removes a given button from the toolbar button collection.
Public method RemoveByKey Removes the ToolBarButton with the specified key from the collection.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public Extension Method AsParallel Enables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension Method AsQueryable Converts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension Method Cast<TResult> Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension Method OfType<TResult> Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top
  Name Description
Explicit interface implemetation Private method ICollection.CopyTo Infrastructure. Copies the elements of the ICollection to an Array, starting at a particular Array index.
Explicit interface implemetation Private property ICollection.IsSynchronized Infrastructure. Gets a value indicating whether access to the collection is synchronized (thread safe).
Explicit interface implemetation Private property ICollection.SyncRoot Infrastructure. Gets an object that can be used to synchronize access to the collection of buttons.
Explicit interface implemetation Private method IList.Add Infrastructure. Adds the specified toolbar button to the end of the toolbar button collection.
Explicit interface implemetation Private method IList.Contains Infrastructure. Determines whether the collection contains a specific value.
Explicit interface implemetation Private method IList.IndexOf Infrastructure. Determines the index of a specific item in the collection.
Explicit interface implemetation Private method IList.Insert Infrastructure. Inserts an existing toolbar button in the toolbar button collection at the specified location.
Explicit interface implemetation Private property IList.IsFixedSize Infrastructure. Gets a value indicating whether the collection has a fixed size.
Explicit interface implemetation Private property IList.Item Infrastructure. Gets or sets the item at a specified index.
Explicit interface implemetation Private method IList.Remove Infrastructure. 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, 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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ