In This Article

BarManagerDockableToolBarCollection Class

Encapsulates a collection of DockableToolBar objects.

public class BarManagerDockableToolBarCollection : SimpleCollection<DockableToolBar>
Inheritance:
object Collection<DockableToolBar> SimpleCollection<DockableToolBar> object

Remarks

This class is a zero-based indexed collection.

Properties

DefaultComparer

Defines the default comparer to be used when sorting. If an explicit default is not defined, an implicit default will be used.

protected override IComparer<DockableToolBar>? DefaultComparer { get; }

Property Value

IComparer<DockableToolBar>

See Also

this[string]

Returns the DockableToolBar with the specified Key.

public DockableToolBar? this[string key] { get; }
Parameter Type Description
key string

The Key of the DockableToolBar to return.

Property Value

DockableToolBar

See Also

Methods

Contains(string)

Determines whether a DockableToolBar is in the collection with the specified Key.

public virtual bool Contains(string key)
Parameter Type Description
key string

The Key of the DockableToolBar to locate in the collection.

Returns

bool:

true if the name is found in the collection; otherwise, false.

See Also

IndexOf(string)

Searches for the specified Key of a DockableToolBar and returns the zero-based index of the first occurrence within the entire collection.

public virtual int IndexOf(string key)
Parameter Type Description
key string

The Key of the DockableToolBar to locate in the collection.

Returns

int:

The zero-based index of the first occurrence of the Key within the entire collection, if found; otherwise, -1.

See Also

OnItemAdded(int, DockableToolBar)

Performs additional custom processes after an item is added to the collection.

protected override void OnItemAdded(int index, DockableToolBar value)
Parameter Type Description
index int

The zero-based index at which the item was inserted.

value DockableToolBar

The object that was inserted.

Remarks

The default implementation of this method is intended to be overridden by a derived class to perform some action after the specified object is added.

See Also

OnItemRemoving(int, DockableToolBar)

Performs additional custom processes before an item is removed from the collection.

protected override void OnItemRemoving(int index, DockableToolBar value)
Parameter Type Description
index int

The zero-based index from which the item was removed.

value DockableToolBar

The object that was removed.

Remarks

The default implementation of this method is intended to be overridden by a derived class to perform some action before the specified object is removed.

See Also

OnValidate(DockableToolBar, int)

Performs additional custom processes when validating a value.

protected override void OnValidate(DockableToolBar value, int existingIndex)
Parameter Type Description
value DockableToolBar

The object to validate.

existingIndex int

The index within the collection of the object that would be replaced by the value.

Remarks

The default implementation of this method determines whether value is null, and if so, throws ArgumentNullException. It is intended to be overridden by a derived class to perform additional action when the specified element is validated.

See Also

Sort()

Sorts the collection by built-in toolbars alphabetically, then by custom toolbars alphabetically.

public void Sort()

See Also

Inherited Members

Extension Methods

See Also