BindingSource::List Property
Gets the list that the connector is bound to.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Property Value
Type: System.Collections::IList^An IList that represents the list, or null if there is no underlying list associated with this BindingSource.
The BindingSource class uniformly handles different data sources. Ideally the List property should be set to a general IList. However, sometimes it may be necessary to cast this property to a more specific type. The following table shows the underlying list type, which depends on the type or value of the data source.
Data source type | Underlying list description |
|---|---|
DataSource and DataMember are null | An empty ArrayList. |
DataSource is null, but DataMember is not null | None; an attempt to get the List will throw an ArgumentException. |
An Array instance | An Array. |
An IListSource instance | The return value from a call to the GetList method of this IListSource instance. |
An IBindingList instance | An IBindingList. |
An IList instance | An IList. |
A non-IList instance of type "T" | A BindingList<T> with one element. |
An ICustomTypeDescriptor instance | An ArrayList with one element. |
An IEnumerable | An ArrayList with the elements copied over. |
The Array type with DataMember of item type "T" | |
A Type that represents an IListSource or ITypedList | An instance created by a call to the CreateInstance(Type^) method of the Activator class. A NotSupportedException may be thrown. |
The IList type with DataMember of item type "T" -or- A non-IList type | |
The ICustomTypeDescriptor type | None; an attempt to get the List will throw an NotSupportedException. |
If the type retrieved is the IList interface, the underlying collection may be more complex, such as an ArrayList or DataView class.
The following code example demonstrates the List, RemoveAt, and Count members. To run this example, paste the code into a form that contains a BindingSource named BindingSource1, two labels named label1 and label2, and a button named button1. Associate the button1_Click method with the Click event for button1. Visual Basic users will need to add a reference to System.Data.dll.
Available since 2.0