Export (0) Print
Expand All

ReadOnlyCollectionBase Class

Provides the abstract base class for a strongly typed non-generic read-only collection.


Namespace:  System.Collections
Assembly:  mscorlib (in mscorlib.dll)

<SerializableAttribute> _
<ComVisibleAttribute(True)> _
Public MustInherit Class ReadOnlyCollectionBase _
	Implements ICollection, IEnumerable

The ReadOnlyCollectionBase type exposes the following members.

Protected methodReadOnlyCollectionBaseInitializes a new instance of the ReadOnlyCollectionBase class.

Public propertyCountGets the number of elements contained in the ReadOnlyCollectionBase instance.
Protected propertyInnerListGets the list of elements contained in the ReadOnlyCollectionBase instance.

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that iterates through the ReadOnlyCollectionBase instance.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public Extension MethodAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodCast(Of TResult)Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodOfType(Of TResult)Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)

Explicit interface implemetationPrivate methodICollection.CopyToCopies the entire ReadOnlyCollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array.
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedGets a value indicating whether access to a ReadOnlyCollectionBase object is synchronized (thread safe).
Explicit interface implemetationPrivate propertyICollection.SyncRootGets an object that can be used to synchronize access to a ReadOnlyCollectionBase object.

A ReadOnlyCollectionBase instance is always read-only. See CollectionBase for a modifiable version of this class.

Notes to Implementers

This base class is provided to make it easier for implementers to create a strongly typed read-only custom collection. Implementers are encouraged to extend this base class instead of creating their own. Members of this base class are protected and are intended to be used through a derived class only.

This class makes the underlying collection available through the InnerList property, which is intended for use only by classes that are derived directly from ReadOnlyCollectionBase. The derived class must ensure that its own users cannot modify the underlying collection.

The following code example implements the ReadOnlyCollectionBase class.

Imports System
Imports System.Collections

Public Class ROCollection
    Inherits ReadOnlyCollectionBase

    Public Sub New(sourceList As IList)
    End Sub 'New 

    Default Public ReadOnly Property Item(index As Integer) As [Object]
            Return InnerList(index)
        End Get 
    End Property 

    Public Function IndexOf(value As [Object]) As Integer 
        Return InnerList.IndexOf(value)
    End Function 'IndexOf

    Public Function Contains(value As [Object]) As Boolean 
        Return InnerList.Contains(value)
    End Function 'Contains

End Class 'ROCollection 

Public Class SamplesCollectionBase

    Public Shared Sub Main()

        ' Create an ArrayList. 
        Dim myAL As New ArrayList()

        ' Create a new ROCollection that contains the elements in myAL. 
        Dim myCol As New ROCollection(myAL)

        ' Display the contents of the collection using For Each. This is the preferred method.
        Console.WriteLine("Contents of the collection (using For Each):")

        ' Display the contents of the collection using the enumerator.
        Console.WriteLine("Contents of the collection (using enumerator):")

        ' Display the contents of the collection using the Count property and the Item property.
        Console.WriteLine("Contents of the collection (using Count and Item):")

        ' Search the collection with Contains and IndexOf.
        Console.WriteLine("Contains yellow: {0}", myCol.Contains("yellow"))
        Console.WriteLine("orange is at index {0}.", myCol.IndexOf("orange"))

    End Sub 'Main

    ' Uses the Count property and the Item property. 
    Public Shared Sub PrintIndexAndValues(myCol As ROCollection)
        Dim i As Integer 
        For i = 0 To myCol.Count - 1
            Console.WriteLine("   [{0}]:   {1}", i, myCol(i))
        Next i
    End Sub 'PrintIndexAndValues

    ' Uses the For Each statement which hides the complexity of the enumerator. 
    ' NOTE: The For Each statement is the preferred way of enumerating the contents of a collection. 
    Public Shared Sub PrintValues1(myCol As ROCollection)
        Dim obj As [Object]
        For Each obj In  myCol
            Console.WriteLine("   {0}", obj)
        Next obj
    End Sub 'PrintValues1

    ' Uses the enumerator.  
    ' NOTE: The For Each statement is the preferred way of enumerating the contents of a collection. 
    Public Shared Sub PrintValues2(myCol As ROCollection)
        Dim myEnumerator As System.Collections.IEnumerator = myCol.GetEnumerator()
        While myEnumerator.MoveNext()
            Console.WriteLine("   {0}", myEnumerator.Current)
        End While
    End Sub 'PrintValues2

End Class 'SamplesCollectionBase 

'This code produces the following output. 

'Contents of the collection (using For Each): 
'   red 
'   blue 
'   yellow 
'   green 
'   orange 
'   purple 

'Contents of the collection (using enumerator): 
'   red 
'   blue 
'   yellow 
'   green 
'   orange 
'   purple 

'Contents of the collection (using Count and Item): 
'   [0]:   red 
'   [1]:   blue 
'   [2]:   yellow 
'   [3]:   green 
'   [4]:   orange 
'   [5]:   purple 

'Contains yellow: True 
'orange is at index 4.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

This implementation does not provide a synchronized (thread safe) wrapper for a ReadOnlyCollectionBase, but derived classes can create their own synchronized versions of the ReadOnlyCollectionBase using the SyncRoot property.

Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads.

© 2015 Microsoft