Export (0) Print
Expand All

BindingSource.DataSource Property

Gets or sets the data source that the connector binds to.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public Object DataSource { get; set; }
/** @property */
public Object get_DataSource ()

/** @property */
public void set_DataSource (Object value)

public function get DataSource () : Object

public function set DataSource (value : Object)

Not applicable.

Property Value

An Object that acts as a data source. The default is a null reference (Nothing in Visual Basic).

The DataSource property can be set to a number of data sources, including types, objects, and lists of types. The resulting data source will be exposed as a list. The following table shows some of the common data sources and the resulting list evaluation.

DataSource property

List results

a null reference (Nothing in Visual Basic)

An empty IBindingList of objects. Adding an item sets the list to the type of the added item.

a null reference (Nothing in Visual Basic) with DataMember set

Not supported, raises ArgumentException.

Non-list type or object of type "T"

Empty IBindingList of type "T".

Array instance

IBindingList containing the array elements.

IEnumerable instance

An IBindingList containing the IEnumerable items.

List instance containing type "T"

IBindingList instance containing type "T".

In addition, DataSource can be set to other list types such as IListSource and ITypedList and the BindingSource will handle them appropriately. In this case, the type contained in the list should have a default constructor.

When setting a data source, if the supplied reference contains more than one list or table, you must set the DataMember property to a string that specifies the list to bind to. Setting this property raises the DataSourceChanged event.

The DataSource property is the default property for the BindingSource class.

The following code example assigns a list of customers to the DataSource of a BindingSource component. This code example is part of a larger example provided at How to: Raise Change Notifications Using the BindingSource ResetItem Method.

private void Form1_Load(System.Object sender, System.EventArgs e)
{
    // Create and populate the list of DemoCustomer objects
    // which will supply data to the DataGridView.
    List<DemoCustomer> customerList = new List<DemoCustomer>();
    customerList.Add(DemoCustomer.CreateNewCustomer());
    customerList.Add(DemoCustomer.CreateNewCustomer());
    customerList.Add(DemoCustomer.CreateNewCustomer());

    // Bind the list to the BindingSource.
    this.customersBindingSource.DataSource = customerList;

    
    // Attach the BindingSource to the DataGridView.
    this.customersDataGridView.DataSource = 
        this.customersBindingSource;
}

private void Form1_Load(Object sender, EventArgs e)
{
    // Create and populate the list of DemoCustomer objects
    // which will supply data to the DataGridView.
    List<DemoCustomer> customerList = new List<DemoCustomer>();
    customerList.Add(DemoCustomer.CreateNewCustomer());
    customerList.Add(DemoCustomer.CreateNewCustomer());
    customerList.Add(DemoCustomer.CreateNewCustomer());
    // Bind the list to the BindingSource.
    this.customersBindingSource.set_DataSource(customerList);
    // Handle the ListChanged event.
    this.customersBindingSource.add_ListChanged(
        new ListChangedEventHandler(customersBindingSource_ListChanged));
    // Attach the BindingSource to the DataGridView.
    this.customersDataGridView.set_DataSource(this.customersBindingSource);
} //Form1_Load

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft