NavigationPaneCollection Class

public class NavigationPaneCollection : IList, ICollection, IEnumerable

public NavigationPaneCollection(Control.ControlCollection navigationBarControls)

Parameter	Type	Description
navigationBarControls	Control.ControlCollection	The control collection to link to.

public virtual int Count { get; }

Property Value

Int32:

The number of panes contained in the collection.

public bool IsFixedSize { get; }

Property Value

Boolean:

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.

public bool IsReadOnly { get; }

Property Value

Boolean:

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

public virtual bool IsSynchronized { get; }

Property Value

Boolean:

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.

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

Parameter	Type	Description
index	Int32	The index of the NavigationPane to return.

Property Value

NavigationPane:

The NavigationPane at the specified index.

public NavigationPane this[string key] { get; }

Parameter	Type	Description
key	String	The key of the NavigationPane to return.

Property Value

NavigationPane:

The NavigationPane with the specified key.

public virtual object SyncRoot { get; }

Property Value

Object:

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

public int Add(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to add.

Returns

Int32:

The index of the NavigationPane that was inserted.

public void AddRange(NavigationPane[] panes)

Parameter	Type	Description
panes	NavigationPane[]	The array of NavigationPane controls to add.

public void Clear()

public bool Contains(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to look for.

Returns

Boolean:

true if the collection contains the NavigationPane; otherwise, false.

public virtual bool Contains(string key)

Parameter	Type	Description
key	String	The key of the NavigationPane to look for.

Returns

Boolean:

true if the collection contains a NavigationPane with the specified key; otherwise, false.

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	Int32	The zero-based index in array at which copying begins.

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.

public int IndexOf(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to look for.

Returns

Int32:

If found, the index where the NavigationPane is in the collection; otherwise, -1.

public int IndexOf(string key)

Parameter	Type	Description
key	String	The key of the NavigationPane to look for.

Returns

Int32:

If found, the index where the NavigationPane is in the collection; otherwise, -1.

public void Insert(int index, NavigationPane pane)

Parameter	Type	Description
index	Int32	The index at which to place the NavigationPane.
pane	NavigationPane	The NavigationPane to add.

public void MoveTo(NavigationPane pane, int newIndex)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to move.
newIndex	Int32	The new index.

public void Remove(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to remove.

public void RemoveAt(int index)

Parameter	Type	Description
index	Int32	The index of the NavigationPane to remove.