WinForms › Explorer Bar › BinaryExplorerBarPanelCollection

BinaryExplorerBarPanelCollection

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WinForms.Controls.NavigationControls

This collection class implements a strongly typed collection of BinaryExplorerBarPanel objects.

public class BinaryExplorerBarPanelCollection : CollectionBase

Inherits from / implements: CollectionBase

Members at a glance

`Item`	Gets the specific BinaryExplorerBarPanel object from the current collection, based on the index argument.
`Add`	Adds a BinaryExplorerBarPanel to the collection.
`AddRange`	Adds a range of BinaryExplorerBarPanel objects to the collection.
`Contains`	This method determines if the input panel object is contained in the current collection.
`IndexOf`	This method gets the index of a given BinaryExplorerBarPanel object in the current collection.
`Insert`	Inserts a BinaryExplorerBarPanel object into a specific location in the collection.
`OnClear`	This override raises the ClearStarting event.
`OnClearComplete`	This override raises the ClearCompleted event.
`OnInsert`	This override raises the PanelObjectInserting event.
`OnInsertComplete`	This override raises the InsertCompleted event.
`OnPanelObjectsCollectionHasChanged`	This raises the PanelObjectsCollectionHasChanged event.
`OnRemove`	This override raises the RemoveStarting event.
`OnRemoveComplete`	This override raises the PanelObjectRemoved event.
`OnSet`	This override raises the SetStarting event.
`OnSetComplete`	This override raises the SetCompleted event.
`OnValidate`	This override raises the Validate event.
`Remove`	Removes a specific BinaryExplorerBarPanel object from the collection.
`ClearCompleted`	This event is raised just after clearing the panel collection.
`ClearStarting`	This event is raised just before clearing the panel collection.
`InsertCompleted`	This event is raised just after adding into the panel collection.
`PanelObjectInserting`	This event is raised just before inserting into the panel collection.
`PanelObjectRemoved`	This event is raised just after removing item from panel collection.
`PanelObjectsCollectionHasChanged`	This event is raised when panel collection has changed.
`RemoveStarting`	This event is raised just before removing items from the panel collection.
`SetCompleted`	This event is raised just after setting an item.
`SetStarting`	This event is raised just before setting an item.
`Validate`	This event is raised when validating an item.

Properties

Item

public BinaryExplorerBarPanel this[int index]

Gets the specific BinaryExplorerBarPanel object from the current collection, based on the index argument.

In C#, this property is the indexer for the class.

Methods

Add

public int Add(BinaryExplorerBarPanel panelObject)

Adds a BinaryExplorerBarPanel to the collection.

panelObject: BinaryExplorerBarPanel to be added.

Returns. Index of the BinaryExplorerBarPanel just added to the collection.

AddRange

public void AddRange(BinaryExplorerBarPanel[] panelObjects)

Adds a range of BinaryExplorerBarPanel objects to the collection.

panelObjects: An array of BinaryExplorerBarPanel objects to be added into the collection.

Contains

public bool Contains(BinaryExplorerBarPanel panelObject)

This method determines if the input panel object is contained in the current collection.

panelObject: A BinaryExplorerBarPanel object.

Returns. Returns true if the specified BinaryExplorerBarPanel object is in the current collection. Otherwise returns false.

IndexOf

public int IndexOf(BinaryExplorerBarPanel panelObject)

This method gets the index of a given BinaryExplorerBarPanel object in the current collection.

panelObject: A BinaryExplorerBarPanel object.

Returns. Returns the index of the specified BinaryExplorerBarPanel object from the current collection.

Insert

public void Insert(int index, BinaryExplorerBarPanel panelObject)

Inserts a BinaryExplorerBarPanel object into a specific location in the collection.

index: Index in the collection where the given panel object should be inserted.
panelObject: A BinaryExplorerBarPanel object.

OnClear

protected override void OnClear()

This override raises the ClearStarting event.

OnClearComplete

protected override void OnClearComplete()

This override raises the ClearCompleted event.

OnInsert

protected override void OnInsert(int index, object panelObject)

This override raises the PanelObjectInserting event.

index: Index where the item is being inserted.
panelObject: Object being inserted.

OnInsertComplete

protected override void OnInsertComplete(int index, object panelObject)

This override raises the InsertCompleted event.

index: Index where the item has been inserted.
panelObject: Object inserted.

OnPanelObjectsCollectionHasChanged

protected virtual void OnPanelObjectsCollectionHasChanged(object sender, EventArgs e)

This raises the PanelObjectsCollectionHasChanged event.

OnRemove

protected override void OnRemove(int index, object panelObject)

This override raises the RemoveStarting event.

index: Index from where the item is being removed.
panelObject: The object being removed.

OnRemoveComplete

protected override void OnRemoveComplete(int index, object panelObject)

This override raises the PanelObjectRemoved event.

index: Index where the item has been removed from.
panelObject: Object that has been removed.

OnSet

protected override void OnSet(int index, object prevObj, object newObj)

This override raises the SetStarting event.

index: Index of the object being set.
prevObj: Prior object value.
newObj: Current (new) object value.

OnSetComplete

protected override void OnSetComplete(int index, object prevObj, object newObj)

This override raises the SetCompleted event.

index: Index of the object that has been set.
prevObj: Prior object value.
newObj: Current (new) object value.

OnValidate

protected override void OnValidate(object validateObject)

This override raises the Validate event.

validateObject: The object that is being validated.

Remove

public void Remove(BinaryExplorerBarPanel panelObject)

Removes a specific BinaryExplorerBarPanel object from the collection.

panelObject: The BinaryExplorerBarPanel object to be removed.

Events

ClearCompleted

public event BinaryExplorerBarPanelCollectionClearedEventHandler ClearCompleted

This event is raised just after clearing the panel collection.

ClearStarting

public event BinaryExplorerBarPanelCollectionClearedEventHandler ClearStarting

This event is raised just before clearing the panel collection.

InsertCompleted

public event BinaryExplorerBarPanelCollectionChangedEventHandler InsertCompleted

This event is raised just after adding into the panel collection.

PanelObjectInserting

public event BinaryExplorerBarPanelCollectionChangedEventHandler PanelObjectInserting

This event is raised just before inserting into the panel collection.

PanelObjectRemoved

public event BinaryExplorerBarPanelCollectionChangedEventHandler PanelObjectRemoved

This event is raised just after removing item from panel collection.

PanelObjectsCollectionHasChanged

public event EventHandler PanelObjectsCollectionHasChanged

This event is raised when panel collection has changed.

RemoveStarting

public event BinaryExplorerBarPanelCollectionChangedEventHandler RemoveStarting

This event is raised just before removing items from the panel collection.

SetCompleted

public event BinaryExplorerBarPanelCollectionSetEventHandler SetCompleted

This event is raised just after setting an item.

SetStarting

public event BinaryExplorerBarPanelCollectionSetEventHandler SetStarting

This event is raised just before setting an item.

Validate

public event BinaryExplorerBarPanelCollectionValidationEventHandler Validate

This event is raised when validating an item.