BarManagerDockableToolBarCollection Class

Namespace:: ActiproSoftware.UI.WinForms.Controls.Bars

Assembly:: ActiproSoftware.Bars.WinForms.dll

Encapsulates a collection of DockableToolBar objects.

public class BarManagerDockableToolBarCollection

Inheritance:: object object

Remarks

This class is a zero-based indexed collection.

Properties

Count

Gets the number of elements contained in the BarManagerDockableToolBarCollection instance.

public virtual int Count { get; }

Property Value

int:: The number of elements contained in the BarManagerDockableToolBarCollection instance.

InnerList

Gets the list of items contained in the collection instance.

protected ArrayList InnerList { get; }

Property Value

ArrayList:: An ArrayList representing the collection instance itself.

IsFixedSize

Gets a value indicating whether the collection has a fixed size.

public virtual bool IsFixedSize { get; }

Property Value

bool:: true if the collection has a fixed size; otherwise, false.

Remarks

A collection with a fixed size does not allow the addition or removal of elements, but it allows the modification of existing elements.

IsReadOnly

Gets a value indicating whether the collection is read-only.

public virtual bool IsReadOnly { get; }

Property Value

bool:: true if the collection is read-only; otherwise, false.

IsSynchronized

Gets a value indicating whether access to the collection is synchronized (thread-safe).

public virtual bool IsSynchronized { get; }

Property Value

bool:: true if the collection is synchronized (thread-safe); otherwise, false.

Remarks

To guarantee the thread safety of the collection, all operations must be done through the wrapper returned by the SyncRoot property.

this[int]

Gets or sets the DockableToolBar at the specified index.

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

public DockableToolBar this[int index] { get; set; }

Parameter	Type	Description
index	int	The index of the DockableToolBar to return.

Property Value

DockableToolBar:: The DockableToolBar at the specified index.

this[string]

Gets the DockableToolBar with the specified Key.

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

public DockableToolBar this[string key] { get; }

Parameter	Type	Description
key	string	The Key of the DockableToolBar to return.

Property Value

DockableToolBar:: The DockableToolBar with the specified Key.

SyncRoot

Gets an Object that can be used to synchronize access to the collection.

public virtual object SyncRoot { get; }

Property Value

object:: An Object that can be used to synchronize access to the collection.

Methods

Add(DockableToolBar)

Adds a DockableToolBar to the end of the collection.

public int Add(DockableToolBar value)

Parameter	Type	Description
value	DockableToolBar	The DockableToolBar to be added to the end of the collection.

Returns

int:: The collection index at which the DockableToolBar has been added.

Clear()

Removes all DockableToolBar objects from the collection.

public void Clear()

Contains(DockableToolBar)

Returns whether the specified DockableToolBar is in the collection.

public virtual bool Contains(DockableToolBar value)

Parameter	Type	Description
value	DockableToolBar	The DockableToolBar to locate in the collection.

Returns

bool:: true if the DockableToolBar is found in the collection; otherwise, false.

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.

CopyTo(Array, int)

Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.

public virtual void CopyTo(Array array, int arrayIndex)

Parameter	Type	Description
array	Array	The one-dimensional `Array` that is the destination of the elements copied from the collection. The `Array` must have zero-based indexing.
arrayIndex	int	The zero-based index in `array` at which copying begins.

GetEnumerator()

Retrieves an IEnumerator object for the entire collection.

public virtual IEnumerator GetEnumerator()

Returns

IEnumerator:: An IEnumerator object for the entire collection

Remarks

Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.

The enumerator does not have exclusive access to the collection.

When an enumerator is instantiated, it takes a snapshot of the current state of the collection. If changes are made to the collection, such as adding, modifying or deleting elements, the snapshot gets out of sync and the enumerator throws an InvalidOperationException. Two enumerators instantiated from the same collection at the same time can have different snapshots of the collection.

IndexOf(DockableToolBar)

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

public virtual int IndexOf(DockableToolBar value)

Parameter	Type	Description
value	DockableToolBar	The DockableToolBar to locate in the collection.

Returns

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

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.

Insert(int, DockableToolBar)

Inserts a DockableToolBar into the collection at the specified index.

public void Insert(int index, DockableToolBar value)

Parameter	Type	Description
index	int	The zero-based index at which the DockableToolBar should be inserted.
value	DockableToolBar	The DockableToolBarto insert.

OnObjectAdded(int, DockableToolBar)

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

protected virtual void OnObjectAdded(int index, DockableToolBar value)

Parameter	Type	Description
index	int	The zero-based index at which the object 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.

OnObjectAdding(int, DockableToolBar)

Performs additional custom processes before an object is added to the collection.

protected virtual void OnObjectAdding(int index, DockableToolBar value)

Parameter	Type	Description
index	int	The zero-based index at which the object 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.

OnObjectRemoved(int, DockableToolBar)

Performs additional custom processes after an object is removed from the collection.

protected virtual void OnObjectRemoved(int index, DockableToolBar value)

Parameter	Type	Description
index	int	The zero-based index from which the object 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 after the specified object is removed.

OnObjectRemoving(int, DockableToolBar)

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

protected virtual void OnObjectRemoving(int index, DockableToolBar value)

Parameter	Type	Description
index	int	The zero-based index from which the object 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.

OnValidate(DockableToolBar, int)

Performs additional custom processes when validating a value.

protected virtual 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.

Remove(DockableToolBar)

Removes the first occurrence of a specific DockableToolBar from the collection.

public void Remove(DockableToolBar value)

Parameter	Type	Description
value	DockableToolBar	The DockableToolBar to remove from the collection.

Remarks

The elements that follow the removed element move up to occupy the vacated spot. The indexes of the elements that are moved are also updated.

RemoveAt(int)

Removes the DockableToolBar at the specified index of the collection.

public void RemoveAt(int index)

Parameter	Type	Description
index	int	The zero-based index of the DockableToolBar to remove.

Remarks

The elements that follow the removed element move up to occupy the vacated spot. The indexes of the elements that are moved are also updated.

Sort()

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

public void Sort()

ToArray()

Copies the items of the collection to a new DockableToolBar array.

public DockableToolBar[] ToArray()

Returns

DockableToolBar[]:: An array of DockableToolBar items.

In This Article

BarManagerDockableToolBarCollection Class

Remarks

Properties

Count

Property Value

See Also

InnerList

Property Value

See Also

IsFixedSize

Property Value

Remarks

See Also

IsReadOnly

Property Value

See Also

IsSynchronized

Property Value

Remarks

See Also

this[int]

Property Value

See Also

this[string]

Property Value

See Also

SyncRoot

Property Value

See Also

Methods

Add(DockableToolBar)

Returns

See Also

Clear()

See Also

Contains(DockableToolBar)

Returns

See Also

Contains(string)

Returns

See Also

CopyTo(Array, int)

See Also

GetEnumerator()

Returns

Remarks

See Also

IndexOf(DockableToolBar)

Returns

See Also

IndexOf(string)

Returns

See Also

Insert(int, DockableToolBar)

See Also

OnObjectAdded(int, DockableToolBar)

Remarks

See Also

OnObjectAdding(int, DockableToolBar)

Remarks

See Also

OnObjectRemoved(int, DockableToolBar)

Remarks

See Also

OnObjectRemoving(int, DockableToolBar)

Remarks

See Also

OnValidate(DockableToolBar, int)

Remarks

See Also

Remove(DockableToolBar)

Remarks

See Also

RemoveAt(int)

Remarks

See Also

Sort()

See Also

ToArray()