TabStripPageCollection Class

Namespace:: ActiproSoftware.UI.WinForms.Controls.Docking

Assembly:: ActiproSoftware.Docking.WinForms.dll

Encapsulates a collection of TabStripPage components.

[TypeConverter(typeof(TabStripPageCollectionConverter))]
public class TabStripPageCollection

Inheritance:: object object

Remarks

This class is a zero-based indexed collection.

Constructors

TabStripPageCollection(ControlCollection)

Initializes an instance of the class.

public TabStripPageCollection(Control.ControlCollection tabStripControls)

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

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

this[int]

The TabStripPage at the specified index.

public TabStripPage this[int index] { get; }

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

Property Value

TabStripPage

this[string]

The TabStripPage with the specified key.

public TabStripPage? this[string key] { get; }

Parameter	Type	Description
key	string	The key of the TabStripPage to return.

Property Value

TabStripPage

Methods

Add(TabStripPage)

Adds an item to the ICollection<T>.

public void Add(TabStripPage item)

Parameter	Type	Description
item	TabStripPage	The object to add to the ICollection<T>.

Exceptions

Type	Condition
NotSupportedException	The ICollection<T> is read-only.

AddRange(IEnumerable<TabStripPage>)

Adds the specified collection of TabStripPage controls to the collection.

public void AddRange(IEnumerable<TabStripPage> pages)

Parameter	Type	Description
pages	IEnumerable<TabStripPage>	The enumerable of TabStripPage controls to add.

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

Type	Condition
NotSupportedException	The ICollection<T> is read-only.

Contains(TabStripPage)

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

public bool Contains(TabStripPage item)

Parameter	Type	Description
item	TabStripPage	The object to locate in the ICollection<T>.

Returns

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

Contains(string)

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

public virtual bool Contains(string key)

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

Returns

bool:: true if the collection contains a TabStripPage with the specified key; otherwise, false.

CopyTo(TabStripPage[], int)

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

public void CopyTo(TabStripPage[] array, int arrayIndex)

Parameter	Type	Description
array	TabStripPage[]	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`.

IndexOf(TabStripPage)

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

public int IndexOf(TabStripPage item)

Parameter	Type	Description
item	TabStripPage	The object to locate in the IList<T>.

Returns

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

IndexOf(string)

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

public int IndexOf(string key)

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

Returns

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

Insert(int, TabStripPage)

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

public void Insert(int index, TabStripPage item)

Parameter	Type	Description
index	int	The zero-based index at which `item` should be inserted.
item	TabStripPage	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.

MoveTo(TabStripPage, int)

Moves a TabStripPage to the specified index.

public void MoveTo(TabStripPage page, int newIndex)

Parameter	Type	Description
page	TabStripPage	The TabStripPage to move.
newIndex	int	The new index.

Remove(TabStripPage)

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

public bool Remove(TabStripPage item)

Parameter	Type	Description
item	TabStripPage	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.

RemoveAt(int)

Removes the TabStripPage at the specified index from the collection.

public void RemoveAt(int index)

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

In This Article

TabStripPageCollection Class

Remarks

Constructors

TabStripPageCollection(ControlCollection)

See Also

Properties

Count

Property Value

See Also

this[int]

Property Value

See Also

this[string]

Property Value

See Also

Methods

Add(TabStripPage)

Exceptions

See Also

AddRange(IEnumerable<TabStripPage>)

See Also

Clear()

Exceptions

See Also

Contains(TabStripPage)

Returns

See Also

Contains(string)

Returns

See Also

CopyTo(TabStripPage[], int)

Exceptions

See Also

IndexOf(TabStripPage)

Returns

See Also

IndexOf(string)

Returns

See Also

Insert(int, TabStripPage)

Exceptions

See Also

MoveTo(TabStripPage, int)

See Also

Remove(TabStripPage)

Returns

Exceptions

See Also

RemoveAt(int)

See Also

Inherited Members

Extension Methods

See Also