In This Article

WizardPageCollection Class

Encapsulates a collection of WizardPage components.

[TypeConverter(typeof(WizardPageCollectionConverter))]
public class WizardPageCollection
Inheritance:
object object

Remarks

This class is a zero-based indexed collection.

Constructors

WizardPageCollection(ControlCollection)

Initializes an instance of the class.

public WizardPageCollection(Control.ControlCollection wizardPageContainerControls)
Parameter Type Description
wizardPageContainerControls Control.ControlCollection

The control collection to link to.

See Also

Properties

Count

Gets the number of elements contained in the ICollection<T>.

public int Count { get; }

Property Value

int:

The number of elements contained in the ICollection<T>.

See Also

this[int]

The WizardPage at the specified index.

public WizardPage this[int index] { get; }
Parameter Type Description
index int

The index of the WizardPage to return.

Property Value

WizardPage

See Also

Methods

Add(WizardPage)

Adds an item to the ICollection<T>.

public void Add(WizardPage item)
Parameter Type Description
item WizardPage

The object to add to the ICollection<T>.

Exceptions

Type Condition
NotSupportedException

The ICollection<T> is read-only.

See Also

AddRange(IEnumerable<WizardPage>)

Adds the specified WizardPage controls to the collection.

public void AddRange(IEnumerable<WizardPage> pages)
Parameter Type Description
pages IEnumerable<WizardPage>

An enumerable of WizardPage controls to add.

See Also

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

Type Condition
NotSupportedException

The ICollection<T> is read-only.

See Also

Contains(WizardPage)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(WizardPage item)
Parameter Type Description
item WizardPage

The object to locate in the ICollection<T>.

Returns

bool:

true if item is found in the ICollection<T>; otherwise, false.

See Also

CopyTo(WizardPage[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(WizardPage[] array, int arrayIndex)
Parameter Type Description
array WizardPage[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

Type Condition
ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

See Also

IndexOf(WizardPage)

Determines the index of a specific item in the IList<T>.

public int IndexOf(WizardPage item)
Parameter Type Description
item WizardPage

The object to locate in the IList<T>.

Returns

int:

The index of item if found in the list; otherwise, -1.

See Also

Insert(int, WizardPage)

Inserts an item to the IList<T> at the specified index.

public void Insert(int index, WizardPage item)
Parameter Type Description
index int

The zero-based index at which item should be inserted.

item WizardPage

The object to insert into the IList<T>.

Exceptions

Type Condition
ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

See Also

MoveTo(WizardPage, int)

Moves a WizardPage to the specified index.

public void MoveTo(WizardPage page, int newIndex)
Parameter Type Description
page WizardPage

The WizardPage to move.

newIndex int

The new index.

See Also

Remove(WizardPage)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(WizardPage item)
Parameter Type Description
item WizardPage

The object to remove from the ICollection<T>.

Returns

bool:

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

Type Condition
NotSupportedException

The ICollection<T> is read-only.

See Also

RemoveAt(int)

Removes the WizardPage at the specified index from the collection.

public void RemoveAt(int index)
Parameter Type Description
index int

The index of the WizardPage to remove.

See Also

Inherited Members

Extension Methods

See Also