閱讀英文版本

分享方式：

CollectionBase 類別

  • 參考

定義

命名空間:
System.Collections
組件:
mscorlib.dll, System.Collections.NonGeneric.dll
組件:
System.Collections.NonGeneric.dll
組件:
mscorlib.dll
組件:
netstandard.dll
來源:
CollectionBase.cs
來源:
CollectionBase.cs
來源:
CollectionBase.cs

為強類型集合提供 abstract 基底類別。

C# 
public abstract class CollectionBase : System.Collections.IList
C# 
[System.Serializable]
public abstract class CollectionBase : System.Collections.IList
C# 
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class CollectionBase : System.Collections.IList
繼承
Object
CollectionBase
衍生
屬性
SerializableAttribute ComVisibleAttribute
實作
ICollection IEnumerable IList

範例

下列程式代碼範例會實作 類別， CollectionBase 並使用該實作 Int16 來建立 物件的集合。

C# 
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

*/

備註

重要

不建議您將 類別用於 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 移除特定物件之第一個符合的元素。

擴充方法

Cast<TResult>(IEnumerable)

將 IEnumerable 的項目轉換成指定的型別。
OfType<TResult>(IEnumerable)

根據指定的型別來篩選 IEnumerable 的項目。
AsParallel(IEnumerable)

啟用查詢的平行化作業。
AsQueryable(IEnumerable)

將 IEnumerable 轉換成 IQueryable。

適用於

產品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1
UWP 10.0

執行緒安全性

Visual Basic 中的公用靜態 (Shared) 此類型的成員是安全線程。 並非所有的執行個體成員都是安全執行緒。

這個實作不提供的同步處理 (線程安全) 包裝CollectionBase函式，但衍生類別可以使用 屬性建立自己的同步版本CollectionBaseSyncRoot。

透過集合列舉本質上不是安全線程程式。 即使集合經過同步化，其他的執行緒仍可修改該集合，使列舉值擲回例外狀況。 若要保證列舉過程的執行緒安全，您可以在整個列舉過程中鎖定集合，或攔截由其他執行緒的變更所造成的例外狀況。

另請參閱