FlexGrid for WinForms | ComponentOne
Data / Bound Mode
In This Topic
    Bound Mode
    In This Topic

    Bound mode, as the name suggests, refers to a state where grid fetches its data from an underlying data source. Data binding also allows multiple data consumers to be connected to a data provider in the synchronized manner.

    FlexGrid supports data binding to most of the commonly used data sources such as ObservableCollection, IList<T>, List<T>, Array, BindingSource, ADO.NET objects such as DataSet, DataTable etc.

    Flexgrid data binding at design time

    There are three ways of binding FlexGrid to a data source:

    Binding at Design Time

    1. In the design view, select the FlexGrid control and click smart tag to open the C1FlexGrid Tasks menu.
    2. Click the Choose Data Source drop down button and select Add Project Data Source... option to open the Data Source Configuration Wizard.
    3. On Choose a Data Source Type page, select Database and click Next.
    4. On Choose a Database Model page, select Dataset and click Next.
    5. On Choose Your Data Connection page, click New Connection to open the Add Connection dialog.
    6. Against the DataSource field, click Change... button to open the Change Data Source dialog.
    7. Select Microsoft Access Database File and click OK to return to the Add Connection dialog.
    8. Against the Database file name field, click Browse and navigate to the database file. Provide the User name and Password, if required to connect to the database file. This example uses C1NWind.mdb file located at the following location by default:
      \Documents\ComponentOne Samples\Common
    9. Click Test Connection to make sure that you have successfully connected to the database or server and click OK.
    10. Click OK again to close the Add Connection dialog box.
    11. Click Next to continue. A dialog box will appear asking if you would like to add the data file to your project and modify the connection string. Choose the appropriate option as per your requirement.
    12. Save the connection string in the application configuration file by checking the Yes, save the connection as box and entering a name.
    13. Click Next to switch to the Choose Your Database Objects page.
    14. Choose a table, say Products from the Tables node and click Finish.
    15. The above steps add a dataset and connection string to your project. Also, Visual Studio automatically creates the following code to fill the dataset:
       // TODO: This line of code loads data into the 'c1NWindDataSet.Products' table. You can move, or remove it, as needed.
       ' TODO: This line of code loads data into the 'c1NWindDataSet.Products' table. You can move, or remove it, as needed.                       

    Binding at Run Time Using DataSource Property

    FlexGrid provides the DataSource property to bind the FlexGrid control to a data source at run time. You need to assign a data source object to the DataSource property of FlexGrid. If the data source object contains more than one table, you can set the DataMember property to table name to specify the target table.

    Following code uses DataSource property to bind data to the WinForms FlexGrid.

    C1DataCollection<Customer> c1DataCollection = new C1DataCollection<Customer>(GetData());
    c1FlexGrid1.DataSource = new C1DataCollectionBindingList(c1DataCollection);
    Dim c1CollectionView As C1.DataCollection.C1DataCollection(Of Customer) = New C1.DataCollection.C1DataCollection(Of Customer)(GetData())
    c1FlexGrid1.DataSource = New C1.DataCollection.BindingList.C1DataCollectionBindingList(c1CollectionView)

    Note that the above sample code uses a custom method named GetData to supply data. You can set up the data source as per your requirements. Following code shows an example of creating data for WinForms FlexGrid.

    ObservableCollection<Customer> GetData()
        var data = new ObservableCollection<Customer>();
        for (int i = 0; i < 25; i++)
            data.Add(new Customer());
        return data;
    Private Function GetData() As ObservableCollection(Of Customer)
        Dim data = New ObservableCollection(Of Customer)()
        For i = 0 To 25 - 1
            data.Add(New Customer())
        Return data
    End Function

    Binding at Run Time Using SetDataBinding Method

    FlexGrid also provides the SetDataBinding method using which you can set DataSource and DataMember properties both using a single call. The following code demonstrates an example of rendering a parent table and its child tables in different grids with the help of the SetDataBinding method.

    Below code demonstrates how to bind data to WinForms FlexGrid using SetDataBinding method.

    // bind data set to grids
    _flexCustomers.SetDataBinding(ds, "Customers");
    _flexOrders.SetDataBinding(ds, "Customers.CustomerOrders");
    _flexOrderDetails.SetDataBinding(ds, "Customers.CustomerOrders.OrderDetails");
    ' Bind data set to grids
    _flexCustomers.SetDataBinding(ds, "Customers")
    _flexOrders.SetDataBinding(ds, "Customers.CustomerOrders")
    _flexOrderDetails.SetDataBinding(ds, "Customers.CustomerOrders.OrderDetails")
    See Also