Skip to main content

CustomHeaderButtonCollection Members

A custom header button collection for tab controls.

Constructors

Name Description
CustomHeaderButtonCollection() Initializes a new CustomHeaderButtonCollection class instance.

Properties

Name Description
Capacity Gets or sets the number of elements that the CollectionBase can contain. Inherited from CollectionBase.
Count Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. Inherited from CollectionBase.
InnerList protected Gets an ArrayList containing the list of elements in the CollectionBase instance. Inherited from CollectionBase.
Item[Int32] Gets a button from the button collection at the specified position.
List protected Gets an IList containing the list of elements in the CollectionBase instance. Inherited from CollectionBase.
ICollection.IsSynchronized Gets a value indicating whether access to the CollectionBase is synchronized (thread safe). Inherited from CollectionBase.
ICollection.SyncRoot Gets an object that can be used to synchronize access to the CollectionBase. Inherited from CollectionBase.
IList.IsFixedSize Gets a value indicating whether the CollectionBase has a fixed size. Inherited from CollectionBase.
IList.IsReadOnly Gets a value indicating whether the CollectionBase is read-only. Inherited from CollectionBase.
IList.Item[Int32] Gets or sets the element at the specified index. Inherited from CollectionBase.
VisibleCount Gets the number of visible buttons in a button collection.

Methods

Name Description
Add(CustomHeaderButton) Adds a custom button to the current button collection.
AddRange(CustomHeaderButton[]) Adds an array of custom buttons to the current button collection.
Assign(CustomHeaderButtonCollection) Copies buttons from the specified CustomHeaderButtonCollection object to the current CustomHeaderButtonCollection object.
BeginUpdate() Locks this CustomHeaderButtonCollection and prevents any visual updates for buttons in this collection. Call the CustomHeaderButtonCollection.EndUpdate method to unlock the collection and redraw its buttons.
CancelUpdate() Cancels the UI lock caused by the CustomHeaderButtonCollection.BeginUpdate method.
Clear() Removes all objects from the CollectionBase instance. This method cannot be overridden. Inherited from CollectionBase.
Contains(CustomHeaderButton) Gets a value that specifies if a custom header button belongs to the current collection.
EndUpdate() Unlocks the CustomHeaderButtonCollection and redraws its buttons to reflect all modifications that have been made while the collection was locked. To lock a collection and prevent its buttons from excessive redraws, call the CustomHeaderButtonCollection.BeginUpdate method.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetEnumerator() Returns an enumerator that iterates through the CollectionBase instance. Inherited from CollectionBase.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
IndexOf(CustomHeaderButton) Gets the specified button’s position in the current CustomHeaderButtonCollection.
Insert(Int32, CustomHeaderButton) Inserts a custom header button to the CustomHeaderButtonCollection at the specified index.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnClearComplete() protected Performs additional custom processes after clearing the contents of the CollectionBase instance. Inherited from CollectionBase.
OnInsert(Int32, Object) protected Performs additional custom processes before inserting a new element into the CollectionBase instance. Inherited from CollectionBase.
OnRemove(Int32, Object) protected Performs additional custom processes when removing an element from the CollectionBase instance. Inherited from CollectionBase.
OnSet(Int32, Object, Object) protected Performs additional custom processes before setting a value in the CollectionBase instance. Inherited from CollectionBase.
OnSetComplete(Int32, Object, Object) protected Performs additional custom processes after setting a value in the CollectionBase instance. Inherited from CollectionBase.
OnValidate(Object) protected Performs additional custom processes when validating a value. Inherited from CollectionBase.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemoveAt(Int32) Removes the element at the specified index of the CollectionBase instance. This method is not overridable. Inherited from CollectionBase.
ICollection.CopyTo(Array, Int32) Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. Inherited from CollectionBase.
IList.Add(Object) Adds an object to the end of the CollectionBase. Inherited from CollectionBase.
IList.Contains(Object) Determines whether the CollectionBase contains a specific element. Inherited from CollectionBase.
IList.IndexOf(Object) Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. Inherited from CollectionBase.
IList.Insert(Int32, Object) Inserts an element into the CollectionBase at the specified index. Inherited from CollectionBase.
IList.Remove(Object) Removes the first occurrence of a specific object from the CollectionBase. Inherited from CollectionBase.
ToString() Returns the current object’s text representation.

Events

Name Description
CollectionChanged Occurs when the current custom header buttons collection is changed.
See Also