ScriptStack.Collections.ReadOnlyICollection< T > Template-Klassenreferenz

Klassendiagramm für ScriptStack.Collections.ReadOnlyICollection< T >:

Öffentliche Methoden
	ReadOnlyICollection (ICollection< T > collectionToWrap)
	Initializes a new instance of the ReadOnlyICollection<T> class.
void	Add (T item)
	Add does not change a ReadOnlyICollection.
void	Clear ()
	Clear does not change a ReadOnlyICollection.
bool	Contains (T item)
	Determines whether the T:System.Collections.Generic.ICollection`1 contains a specific value.
void	CopyTo (T[] array, int arrayIndex)
	Copies the elements of the T:System.Collections.Generic.ICollection`1 to an T:System.Array, starting at a particular T:System.Array index.
bool	Remove (T item)
	Remove does not change a ReadOnlyICollection.
IEnumerator< T >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.

Öffentliche, statische Methoden
static ReadOnlyICollection< T >	AsReadOnly (ICollection< T > collectionToWrap)
	Returned a read only wrapper around the collectionToWrap.

Propertys
bool	IsReadOnly [get]
	Gets a value indicating whether the T:System.Collections.Generic.ICollection`1 is read-only.
int	Count [get]
	Gets the number of elements contained in the T:System.Collections.Generic.ICollection`1.

Private Methoden
IEnumerator IEnumerable.	GetEnumerator ()
	Returns an enumerator that iterates through a collection.

Private Attribute
ICollection< T >	m_collection

Beschreibung der Konstruktoren und Destruktoren

ReadOnlyICollection()

ScriptStack.Collections.ReadOnlyICollection< T >.ReadOnlyICollection

(

ICollection< T >

collectionToWrap

)

Initializes a new instance of the ReadOnlyICollection<T> class.

Parameter

collectionToWrap

The collection to wrap.

        {
            m_collection = collectionToWrap;
        }

Benutzt ScriptStack.Collections.ReadOnlyICollection< T >.m_collection.

Dokumentation der Elementfunktionen

Add()

void ScriptStack.Collections.ReadOnlyICollection< T >.Add

(

T

item

)

Add does not change a ReadOnlyICollection.

Parameter

item	The object to add to the T:System.Collections.Generic.ICollection`1.

Ausnahmebehandlung

T:System.NotSupportedException

The T:System.Collections.Generic.ICollection`1 is read-only.

        {
        }

AsReadOnly()

static ReadOnlyICollection< T > ScriptStack.Collections.ReadOnlyICollection< T >.AsReadOnly ( ICollection< T > collectionToWrap )

static

Returned a read only wrapper around the collectionToWrap.

Parameter

collectionToWrap

The collection to wrap.

Rückgabe

        {
            return new ReadOnlyICollection<T>(collectionToWrap);
        }

Clear()

void ScriptStack.Collections.ReadOnlyICollection< T >.Clear

(

)

Clear does not change a ReadOnlyICollection.

Ausnahmebehandlung

T:System.NotSupportedException

The T:System.Collections.Generic.ICollection`1 is read-only.

        {
        }

Contains()

bool ScriptStack.Collections.ReadOnlyICollection< T >.Contains

(

T

item

)

Determines whether the T:System.Collections.Generic.ICollection`1 contains a specific value.

Parameter

item	The object to locate in the T:System.Collections.Generic.ICollection`1.

Rückgabe

true if item is found in the T:System.Collections.Generic.ICollection`1; otherwise, false.

        {
            return m_collection.Contains(item);
        }

Benutzt ScriptStack.Collections.ReadOnlyDictionary< TKey, TValue >.Contains() und ScriptStack.Collections.ReadOnlyICollection< T >.m_collection.

CopyTo()

void ScriptStack.Collections.ReadOnlyICollection< T >.CopyTo	(	T[]	array,
		int	arrayIndex )

Copies the elements of the T:System.Collections.Generic.ICollection`1 to an T:System.Array, starting at a particular T:System.Array index.

Parameter

array	The one-dimensional T:System.Array that is the destination of the elements copied from T:System.Collections.Generic.ICollection`1. The T:System.Array must have zero-based indexing.
arrayIndex	The zero-based index in array at which copying begins.

Ausnahmebehandlung

T:System.ArgumentOutOfRangeException	arrayIndex is less than 0.
T:System.ArgumentNullException	array is null.
T:System.ArgumentException	array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source T:System.Collections.Generic.ICollection`1 is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.

        {
            m_collection.CopyTo(array, arrayIndex);
        }

Benutzt ScriptStack.Collections.ReadOnlyDictionary< TKey, TValue >.CopyTo() und ScriptStack.Collections.ReadOnlyICollection< T >.m_collection.

GetEnumerator() [1/2]

IEnumerator IEnumerable. ScriptStack.Collections.ReadOnlyICollection< T >.GetEnumerator ( )

private

Returns an enumerator that iterates through a collection.

Rückgabe

An T:System.Collections.IEnumerator object that can be used to iterate through the collection.

        {
            return m_collection.GetEnumerator();
        }

Benutzt ScriptStack.Collections.ReadOnlyDictionary< TKey, TValue >.GetEnumerator() und ScriptStack.Collections.ReadOnlyICollection< T >.m_collection.

GetEnumerator() [2/2]

IEnumerator< T > ScriptStack.Collections.ReadOnlyICollection< T >.GetEnumerator

(

)

Returns an enumerator that iterates through the collection.

Rückgabe

A T:System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.

        {
            return m_collection.GetEnumerator();
        }

Benutzt ScriptStack.Collections.ReadOnlyDictionary< TKey, TValue >.GetEnumerator() und ScriptStack.Collections.ReadOnlyICollection< T >.m_collection.

Remove()

bool ScriptStack.Collections.ReadOnlyICollection< T >.Remove

(

T

item

)

Remove does not change a ReadOnlyICollection.

Parameter

item	The object to remove from the T:System.Collections.Generic.ICollection`1.

Rückgabe

true if item was successfully removed from the T:System.Collections.Generic.ICollection`1; otherwise, false. This method also returns false if item is not found in the original T:System.Collections.Generic.ICollection`1.

Ausnahmebehandlung

T:System.NotSupportedException

The T:System.Collections.Generic.ICollection`1 is read-only.

        {
            return false;
        }

Dokumentation der Datenelemente

m_collection

ICollection<T> ScriptStack.Collections.ReadOnlyICollection< T >.m_collection

private

Wird benutzt von ScriptStack.Collections.ReadOnlyICollection< T >.Contains(), ScriptStack.Collections.ReadOnlyICollection< T >.CopyTo(), ScriptStack.Collections.ReadOnlyICollection< T >.GetEnumerator() und ScriptStack.Collections.ReadOnlyICollection< T >.ReadOnlyICollection().

Dokumentation der Propertys

Count

int ScriptStack.Collections.ReadOnlyICollection< T >.Count

get

Gets the number of elements contained in the T:System.Collections.Generic.ICollection`1.

Rückgabe

The number of elements contained in the T:System.Collections.Generic.ICollection`1.

        {
            get
            {
                return m_collection.Count;
            }
        }

IsReadOnly

bool ScriptStack.Collections.ReadOnlyICollection< T >.IsReadOnly

get

Gets a value indicating whether the T:System.Collections.Generic.ICollection`1 is read-only.

Rückgabe

true if the T:System.Collections.Generic.ICollection`1 is read-only; otherwise, false.

        {
            get
            {
                return true;
            }
        }

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• C:/Users/manuel/Desktop/doc/Collections/ReadOnlyICollection.cs