CollectionBase Класс

Определение

Пространство имен:: System.Collections

Сборки:: mscorlib.dll, System.Collections.NonGeneric.dll

Сборки:: netstandard.dll, System.Collections.NonGeneric.dll

Сборка:: System.Collections.NonGeneric.dll

Сборка:: mscorlib.dll

Сборка:: netstandard.dll

Исходный код:: CollectionBase.cs

Исходный код:: CollectionBase.cs

Исходный код:: CollectionBase.cs

Исходный код:: CollectionBase.cs

Исходный код:: CollectionBase.cs

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Предоставляет базовый abstract класс для строго типизированной коллекции.

public ref class CollectionBase abstract : System::Collections::IList

public abstract class CollectionBase : System.Collections.IList

[System.Serializable]
public abstract class CollectionBase : System.Collections.IList

[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class CollectionBase : System.Collections.IList

type CollectionBase = class
    interface ICollection
    interface IEnumerable
    interface IList

[<System.Serializable>]
type CollectionBase = class
    interface IList
    interface ICollection
    interface IEnumerable

[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type CollectionBase = class
    interface IList
    interface ICollection
    interface IEnumerable

Public MustInherit Class CollectionBase
Implements IList

Наследование: Object
CollectionBase

Производный: System.CodeDom.CodeAttributeArgumentCollection

System.CodeDom.CodeAttributeDeclarationCollection

System.CodeDom.CodeCatchClauseCollection

System.CodeDom.CodeCommentStatementCollection

System.CodeDom.CodeDirectiveCollection

Подробнее…

Атрибуты: SerializableAttribute ComVisibleAttribute

Реализации: ICollection IEnumerable IList

Примеры

В следующем примере кода реализуется CollectionBase класс и используется эта реализация для создания коллекции Int16 объектов.

using System;
using System.Collections;

public class Int16Collection : CollectionBase  {

   public Int16 this[ int index ]  {
      get  {
         return( (Int16) List[index] );
      }
      set  {
         List[index] = value;
      }
   }

   public int Add( Int16 value )  {
      return( List.Add( value ) );
   }

   public int IndexOf( Int16 value )  {
      return( List.IndexOf( value ) );
   }

   public void Insert( int index, Int16 value )  {
      List.Insert( index, value );
   }

   public void Remove( Int16 value )  {
      List.Remove( value );
   }

   public bool Contains( Int16 value )  {
      // If value is not of type Int16, this will return false.
      return( List.Contains( value ) );
   }

   protected override void OnInsert( int index, Object value )  {
      // Insert additional code to be run only when inserting values.
   }

   protected override void OnRemove( int index, Object value )  {
      // Insert additional code to be run only when removing values.
   }

   protected override void OnSet( int index, Object oldValue, Object newValue )  {
      // Insert additional code to be run only when setting values.
   }

   protected override void OnValidate( Object value )  {
      if ( value.GetType() != typeof(System.Int16) )
         throw new ArgumentException( "value must be of type Int16.", "value" );
   }
}

public class SamplesCollectionBase  {

   public static void Main()  {

      // Create and initialize a new CollectionBase.
      Int16Collection myI16 = new Int16Collection();

      // Add elements to the collection.
      myI16.Add( (Int16) 1 );
      myI16.Add( (Int16) 2 );
      myI16.Add( (Int16) 3 );
      myI16.Add( (Int16) 5 );
      myI16.Add( (Int16) 7 );

      // Display the contents of the collection using foreach. This is the preferred method.
      Console.WriteLine( "Contents of the collection (using foreach):" );
      PrintValues1( myI16 );

      // Display the contents of the collection using the enumerator.
      Console.WriteLine( "Contents of the collection (using enumerator):" );
      PrintValues2( myI16 );

      // Display the contents of the collection using the Count property and the Item property.
      Console.WriteLine( "Initial contents of the collection (using Count and Item):" );
      PrintIndexAndValues( myI16 );

      // Search the collection with Contains and IndexOf.
      Console.WriteLine( "Contains 3: {0}", myI16.Contains( 3 ) );
      Console.WriteLine( "2 is at index {0}.", myI16.IndexOf( 2 ) );
      Console.WriteLine();

      // Insert an element into the collection at index 3.
      myI16.Insert( 3, (Int16) 13 );
      Console.WriteLine( "Contents of the collection after inserting at index 3:" );
      PrintIndexAndValues( myI16 );

      // Get and set an element using the index.
      myI16[4] = 123;
      Console.WriteLine( "Contents of the collection after setting the element at index 4 to 123:" );
      PrintIndexAndValues( myI16 );

      // Remove an element from the collection.
      myI16.Remove( (Int16) 2 );

      // Display the contents of the collection using the Count property and the Item property.
      Console.WriteLine( "Contents of the collection after removing the element 2:" );
      PrintIndexAndValues( myI16 );
   }

   // Uses the Count property and the Item property.
   public static void PrintIndexAndValues( Int16Collection myCol )  {
      for ( int i = 0; i < myCol.Count; i++ )
         Console.WriteLine( "   [{0}]:   {1}", i, myCol[i] );
      Console.WriteLine();
   }

   // Uses the foreach statement which hides the complexity of the enumerator.
   // NOTE: The foreach statement is the preferred way of enumerating the contents of a collection.
   public static void PrintValues1( Int16Collection myCol )  {
      foreach ( Int16 i16 in myCol )
         Console.WriteLine( "   {0}", i16 );
      Console.WriteLine();
   }

   // Uses the enumerator.
   // NOTE: The foreach statement is the preferred way of enumerating the contents of a collection.
   public static void PrintValues2( Int16Collection myCol )  {
      System.Collections.IEnumerator myEnumerator = myCol.GetEnumerator();
      while ( myEnumerator.MoveNext() )
         Console.WriteLine( "   {0}", myEnumerator.Current );
      Console.WriteLine();
   }
}


/*
This code produces the following output.

Contents of the collection (using foreach):
   1
   2
   3
   5
   7

Contents of the collection (using enumerator):
   1
   2
   3
   5
   7

Initial contents of the collection (using Count and Item):
   [0]:   1
   [1]:   2
   [2]:   3
   [3]:   5
   [4]:   7

Contains 3: True
2 is at index 1.

Contents of the collection after inserting at index 3:
   [0]:   1
   [1]:   2
   [2]:   3
   [3]:   13
   [4]:   5
   [5]:   7

Contents of the collection after setting the element at index 4 to 123:
   [0]:   1
   [1]:   2
   [2]:   3
   [3]:   13
   [4]:   123
   [5]:   7

Contents of the collection after removing the element 2:
   [0]:   1
   [1]:   3
   [2]:   13
   [3]:   123
   [4]:   7

*/

Imports System.Collections


Public Class Int16Collection
   Inherits CollectionBase


   Default Public Property Item(index As Integer) As Int16
      Get
         Return CType(List(index), Int16)
      End Get
      Set
         List(index) = value
      End Set
   End Property


   Public Function Add(value As Int16) As Integer
      Return List.Add(value)
   End Function 'Add

   Public Function IndexOf(value As Int16) As Integer
      Return List.IndexOf(value)
   End Function 'IndexOf


   Public Sub Insert(index As Integer, value As Int16)
      List.Insert(index, value)
   End Sub


   Public Sub Remove(value As Int16)
      List.Remove(value)
   End Sub


   Public Function Contains(value As Int16) As Boolean
      ' If value is not of type Int16, this will return false.
      Return List.Contains(value)
   End Function 'Contains


   Protected Overrides Sub OnInsert(index As Integer, value As Object)
      ' Insert additional code to be run only when inserting values.
   End Sub


   Protected Overrides Sub OnRemove(index As Integer, value As Object)
      ' Insert additional code to be run only when removing values.
   End Sub


   Protected Overrides Sub OnSet(index As Integer, oldValue As Object, newValue As Object)
      ' Insert additional code to be run only when setting values.
   End Sub


   Protected Overrides Sub OnValidate(value As Object)
      If Not GetType(System.Int16).IsAssignableFrom(value.GetType()) Then
         Throw New ArgumentException("value must be of type Int16.", "value")
      End If
   End Sub

End Class


Public Class SamplesCollectionBase

   Public Shared Sub Main()

      ' Creates and initializes a new CollectionBase.
      Dim myI16 As New Int16Collection()

      ' Adds elements to the collection.
      myI16.Add( 1 )
      myI16.Add( 2 )
      myI16.Add( 3 )
      myI16.Add( 5 )
      myI16.Add( 7 )

      ' Display the contents of the collection using For Each. This is the preferred method.
      Console.WriteLine("Contents of the collection (using For Each):")
      PrintValues1(myI16)
      
      ' Display the contents of the collection using the enumerator.
      Console.WriteLine("Contents of the collection (using enumerator):")
      PrintValues2(myI16)
      
      ' Display the contents of the collection using the Count property and the Item property.
      Console.WriteLine("Initial contents of the collection (using Count and Item):")
      PrintIndexAndValues(myI16)
      
      ' Searches the collection with Contains and IndexOf.
      Console.WriteLine("Contains 3: {0}", myI16.Contains(3))
      Console.WriteLine("2 is at index {0}.", myI16.IndexOf(2))
      Console.WriteLine()
      
      ' Inserts an element into the collection at index 3.
      myI16.Insert(3, 13)
      Console.WriteLine("Contents of the collection after inserting at index 3:")
      PrintIndexAndValues(myI16)
      
      ' Gets and sets an element using the index.
      myI16(4) = 123
      Console.WriteLine("Contents of the collection after setting the element at index 4 to 123:")
      PrintIndexAndValues(myI16)
      
      ' Removes an element from the collection.
      myI16.Remove(2)

      ' Display the contents of the collection using the Count property and the Item property.
      Console.WriteLine("Contents of the collection after removing the element 2:")
      PrintIndexAndValues(myI16)

    End Sub


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


    ' 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 Int16Collection)
      Dim i16 As Int16
      For Each i16 In  myCol
          Console.WriteLine("   {0}", i16)
      Next i16
      Console.WriteLine()
    End Sub


    ' 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 Int16Collection)
      Dim myEnumerator As System.Collections.IEnumerator = myCol.GetEnumerator()
      While myEnumerator.MoveNext()
          Console.WriteLine("   {0}", myEnumerator.Current)
      End While
      Console.WriteLine()
    End Sub

End Class


'This code produces the following output.
'
'Contents of the collection (using For Each):
'   1
'   2
'   3
'   5
'   7
'
'Contents of the collection (using enumerator):
'   1
'   2
'   3
'   5
'   7
'
'Initial contents of the collection (using Count and Item):
'   [0]:   1
'   [1]:   2
'   [2]:   3
'   [3]:   5
'   [4]:   7
'
'Contains 3: True
'2 is at index 1.
'
'Contents of the collection after inserting at index 3:
'   [0]:   1
'   [1]:   2
'   [2]:   3
'   [3]:   13
'   [4]:   5
'   [5]:   7
'
'Contents of the collection after setting the element at index 4 to 123:
'   [0]:   1
'   [1]:   2
'   [2]:   3
'   [3]:   13
'   [4]:   123
'   [5]:   7
'
'Contents of the collection after removing the element 2:
'   [0]:   1
'   [1]:   3
'   [2]:   13
'   [3]:   123
'   [4]:   7

Мы не рекомендуем использовать CollectionBase класс для новой разработки. Вместо этого рекомендуется использовать универсальный Collection<T> класс. Дополнительные сведения см. в статье, не относящийся к универсальным коллекциям, которые не должны использоваться на сайте GitHub.

Экземпляр CollectionBase всегда изменяется. Ознакомьтесь ReadOnlyCollectionBase с версией этого класса, доступной только для чтения.

Емкость CollectionBase — это количество элементов, которые CollectionBase могут храниться. Так как элементы добавляются в объект CollectionBase, емкость автоматически увеличивается по мере необходимости при перемещении. Емкость можно уменьшить, задав Capacity свойство явным образом.

Примечания для тех, кто реализует этот метод

Этот базовый класс предоставляется для упрощения создания строго типизированной пользовательской коллекции. Разработчики рекомендуется расширить этот базовый класс вместо создания собственных.

Конструкторы

Имя	Описание
CollectionBase()	Инициализирует новый экземпляр CollectionBase класса с начальной емкостью по умолчанию.
CollectionBase(Int32)	Инициализирует новый экземпляр CollectionBase класса с указанной емкостью.

Свойства

Имя	Описание
Capacity	Возвращает или задает количество элементов, которые CollectionBase могут содержаться.
Count	Возвращает количество элементов, содержащихся в экземпляре CollectionBase . Это свойство нельзя переопределить.
InnerList	ArrayList Возвращает список элементов в экземпляреCollectionBase.
List	IList Возвращает список элементов в экземпляреCollectionBase.

Методы

Имя	Описание
Clear()	Удаляет все объекты из экземпляра CollectionBase . Этот метод нельзя переопределить.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetEnumerator()	Возвращает перечислитель, который выполняет итерацию по экземпляру CollectionBase .
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
OnClear()	Выполняет дополнительные пользовательские процессы при очистке содержимого экземпляра CollectionBase .
OnClearComplete()	Выполняет дополнительные пользовательские процессы после очистки содержимого экземпляра CollectionBase .
OnInsert(Int32, Object)	Выполняет дополнительные пользовательские процессы перед вставкой нового элемента в CollectionBase экземпляр.
OnInsertComplete(Int32, Object)	Выполняет дополнительные пользовательские процессы после вставки нового элемента в CollectionBase экземпляр.
OnRemove(Int32, Object)	Выполняет дополнительные пользовательские процессы при удалении элемента из экземпляра CollectionBase .
OnRemoveComplete(Int32, Object)	Выполняет дополнительные пользовательские процессы после удаления элемента из экземпляра CollectionBase .
OnSet(Int32, Object, Object)	Выполняет дополнительные пользовательские процессы перед заданием значения в экземпляре CollectionBase .
OnSetComplete(Int32, Object, Object)	Выполняет дополнительные пользовательские процессы после задания значения в экземпляре CollectionBase .
OnValidate(Object)	Выполняет дополнительные пользовательские процессы при проверке значения.
RemoveAt(Int32)	Удаляет элемент по указанному индексу экземпляра CollectionBase . Этот метод не переопределяется.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

Явные реализации интерфейса

Имя	Описание
ICollection.CopyTo(Array, Int32)	Копирует все CollectionBase в совместимое одномерное Arrayзначение, начиная с указанного индекса целевого массива.
ICollection.IsSynchronized	Возвращает значение, указывающее, синхронизирован ли доступ к CollectionBase синхронизированному (потокобезопасно).
ICollection.SyncRoot	Получает объект, который можно использовать для синхронизации доступа к объекту CollectionBase.
IList.Add(Object)	Добавляет объект в конец CollectionBase.
IList.Contains(Object)	Определяет, содержит ли CollectionBase определенный элемент.
IList.IndexOf(Object)	Выполняет поиск указанного Object и возвращает отсчитываемый от нуля индекс первого вхождения в течение всего CollectionBase.
IList.Insert(Int32, Object)	Вставляет элемент в CollectionBase указанный индекс.
IList.IsFixedSize	Возвращает значение, указывающее, имеет ли CollectionBase размер фиксированного размера.
IList.IsReadOnly	Возвращает значение, указывающее, доступен ли доступ CollectionBase только для чтения.
IList.Item[Int32]	Возвращает или задает элемент по указанному индексу.
IList.Remove(Object)	Удаляет первое вхождение определенного объекта из CollectionBase.

Методы расширения

Имя	Описание
AsParallel(IEnumerable)	Включает параллелизацию запроса.
AsQueryable(IEnumerable)	Преобразует IEnumerable в IQueryable.
Cast<TResult>(IEnumerable)	Приведение элементов IEnumerable к указанному типу.
OfType<TResult>(IEnumerable)	Фильтрует элементы IEnumerable на основе указанного типа.

Применяется к

Потокобезопасность

Общедоступные статические (Shared в Visual Basic) элементы этого типа являются потокобезопасны. Никакие члены экземпляра не гарантированы как потокобезопасные.

Эта реализация не предоставляет синхронизированную (потокобезопасную) оболочку для класса CollectionBase, но производные классы CollectionBase SyncRoot могут создавать собственные синхронизированные версии свойства.

Перечисление через коллекцию по сути не является потокобезопасной процедурой. Даже если коллекция синхронизирована, другие потоки по-прежнему могут изменять коллекцию, что приводит к возникновению исключения перечислителем. Чтобы гарантировать безопасность потоков во время перечисления, можно заблокировать коллекцию во время всего перечисления или поймать исключения, полученные из изменений, внесенных другими потоками.

См. также раздел

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через