In This Article

BarModeCollection Class

Encapsulates a collection of modes.

[TypeConverter(typeof(BarModeCollectionConverter))]
public class BarModeCollection
Inheritance:
object object

Remarks

This class is a zero-based indexed collection.

Constructors

BarModeCollection()

Initializes a new instance of the BarModeCollection class.

public BarModeCollection()

Properties

Count

Gets the number of elements contained in the collection instance.

public virtual int Count { get; }

Property Value

int:

The number of elements contained in the collection 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 string at the specified index.

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

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

The index of the string to return.

Property Value

string:

The string at the specified index.

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

Adds a string to the end of the collection.

public int Add(string value)
Parameter Type Description
value string

The string to be added to the end of the collection.

Returns

int:

The collection index at which the string has been added.

AddRange(string[])

Adds multiple string objects to the collection.

public void AddRange(string[] items)
Parameter Type Description
items string[]

The array of string objects to add.

Clear()

Removes all string objects from the collection.

public void Clear()

Contains(string)

Returns whether the specified string is in the collection.

public virtual bool Contains(string value)
Parameter Type Description
value string

The string to locate in the collection.

Returns

bool:

true if the string 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(string)

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

public virtual int IndexOf(string value)
Parameter Type Description
value string

The string to locate in the collection.

Returns

int:

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

Insert(int, string)

Inserts a string into the collection at the specified index.

public void Insert(int index, string value)
Parameter Type Description
index int

The zero-based index at which the string should be inserted.

value string

The stringto insert.

OnObjectAdded(int, string)

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

protected virtual void OnObjectAdded(int index, string value)
Parameter Type Description
index int

The zero-based index at which the object was inserted.

value string

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, string)

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

protected virtual void OnObjectAdding(int index, string value)
Parameter Type Description
index int

The zero-based index at which the object was inserted.

value string

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, string)

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

protected virtual void OnObjectRemoved(int index, string value)
Parameter Type Description
index int

The zero-based index from which the object was removed.

value string

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, string)

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

protected virtual void OnObjectRemoving(int index, string value)
Parameter Type Description
index int

The zero-based index from which the object was removed.

value string

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(string, int)

Performs additional custom processes when validating a value.

protected virtual void OnValidate(string value, int existingIndex)
Parameter Type Description
value string

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

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

public void Remove(string value)
Parameter Type Description
value string

The string 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 string at the specified index of the collection.

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

The zero-based index of the string 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.

ToArray()

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

public string[] ToArray()

Returns

string[]:

An array of string items.

Inherited Members