NavigationPaneCollection Class

Namespace:: ActiproSoftware.UI.WinForms.Controls.Navigation

Assembly:: ActiproSoftware.Navigation.WinForms.dll

Encapsulates a collection of NavigationPane components.

[TypeConverter(typeof(NavigationPaneCollectionConverter))]
public class NavigationPaneCollection

Inheritance:: object object

Remarks

This class is a zero-based indexed collection.

Constructors

NavigationPaneCollection(ControlCollection)

Initializes a new instance of the NavigationPaneCollection class.

public NavigationPaneCollection(Control.ControlCollection navigationBarControls)

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

Properties

Count

Gets the number of panes contained in the collection.

public virtual int Count { get; }

Property Value

int:: The number of panes contained in the collection.

IsFixedSize

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

public 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 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 the NavigationPane at the specified index.

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

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

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

Property Value

NavigationPane:: The NavigationPane at the specified index.

this[string]

Gets the NavigationPane with the specified key.

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.

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(NavigationPane)

Adds the specified NavigationPane to the collection.

public int Add(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to add.

Returns

int:: The index of the NavigationPane that was inserted.

AddRange(NavigationPane[])

Adds the specified array of NavigationPane controls to the collection.

public void AddRange(NavigationPane[] panes)

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

Clear()

Removes all NavigationPane objects from the collection.

public void Clear()

Contains(NavigationPane)

Determines whether the specified NavigationPane is in the collection.

public bool Contains(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to look for.

Returns

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

Contains(string)

Determines whether the a NavigationPane with the specified key is in the collection.

public virtual bool Contains(string key)

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

Returns

bool:: true if the collection contains a NavigationPane with the specified key; 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(NavigationPane)

Returns the index of the specified NavigationPane in the collection.

public int IndexOf(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to look for.

Returns

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

IndexOf(string)

Returns the index of the NavigationPane with the specified key in the collection.

public int IndexOf(string key)

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

Returns

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

Insert(int, NavigationPane)

Inserts an NavigationPane into the specified location in the collection.

public void Insert(int index, NavigationPane pane)

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

MoveTo(NavigationPane, int)

Moves a NavigationPane to the specified index.

public void MoveTo(NavigationPane pane, int newIndex)

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

Remove(NavigationPane)

Removes the specified NavigationPane from the collection.

public void Remove(NavigationPane pane)

Parameter	Type	Description
pane	NavigationPane	The NavigationPane to remove.

RemoveAt(int)

Removes the NavigationPane at the specified index from the collection.

public void RemoveAt(int index)

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

In This Article

NavigationPaneCollection Class

Remarks

Constructors

NavigationPaneCollection(ControlCollection)

See Also

Properties

Count

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(NavigationPane)

Returns

See Also

AddRange(NavigationPane[])

See Also

Clear()

See Also

Contains(NavigationPane)

Returns

See Also

Contains(string)

Returns

See Also

CopyTo(Array, int)

See Also

GetEnumerator()

Returns

Remarks

See Also

IndexOf(NavigationPane)

Returns

See Also

IndexOf(string)

Returns

See Also

Insert(int, NavigationPane)

See Also

MoveTo(NavigationPane, int)

See Also

Remove(NavigationPane)

See Also

RemoveAt(int)

See Also

Inherited Members

See Also