Ready to get started?

Learn more about the CData ADO.NET Provider for Magento or download a free trial:

Download Now

DataBind Charts to Magento Data

Use the standard ADO.NET procedures for databinding to provide bidirectional access to Magento data from controls in the Visual Studio toolbox. This article demonstrates a graphical approach using wizards in Visual Studio, as well as how to databind with only a few lines of code.

DataBinding enables bidirectional access to data from UI controls. You can use the CData ADO.NET Provider for Magento to easily databind Magento data to Windows Forms and Web controls in Visual Studio. This article shows how to use wizards to databind Magento data to a chart that reflects any changes. The code walk-through section shows how to create a chart in 10 lines of code.

DataBind to a Chart

DataBinding consists of three steps: Instantiate the control, configure the data source, and databind.

Configure the Connection and Select Database Objects

Follow the procedure below to use the Data Source Configuration Wizard to create a chart control and the connection to Magento. In the wizard, you can select the Magento entities you want to databind.

  1. In a Windows Forms project, drag and drop a Chart control from the toolbox to the form. In the Data section of the Chart properties, select DataSource and then select Add Project Data Source from the menu.
  2. In the Data Source Configuration Wizard that appears, select Database -> Dataset.
  3. In the Choose Your Data Connection step, click New Connection.
  4. In the Add Connection dialog, click Change to select the CData Magento Data Source.

    Below is a typical connection string:

    OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH

    Magento uses the OAuth 1 authentication standard. To connect to the Magento REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Magento system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

    You will also need to provide the URL to your Magento system. The URL depends on whether you are using the Magento REST API as a customer or administrator.

    • Customer: To use Magento as a customer, make sure you have created a customer account in the Magento homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Magento system.

    • Administrator: To access Magento as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

      If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

  5. Choose the database objects you want to work with. This example uses the Products table.

DataBind

After adding the data source and selecting database objects, you can bind the objects to the chart. This example assigns the x-axis to Name and the y-axis to Price.

  1. In the Chart properties, click the button in the Series property to open the Series Collection Editor.
  2. In the Series properties, select the columns you want for the x- and y-axes: Select columns from the menu in the XValueMember and YValueMember properties.

The chart is now databound to the Magento data. Run the chart to display the current data.

Code Walk-through

DataBinding to Magento data requires only a few lines of code and can be completed in three easy steps.

  1. Connect to Magento.
  2. Create the MagentoDataAdapter to execute the query and create a DataSet to be filled with its results.
  3. DataBind the result set to the chart.

Below is the complete code:

MagentoConnection conn = new MagentoConnection("OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH"); MagentoCommand comm = new MagentoCommand("SELECT Name, Price FROM Products", conn); MagentoDataAdapter da = new MagentoDataAdapter(comm); DataSet dataset = new DataSet(); da.Fill(dataset); chart1.DataSource = dataset; chart1.Series[0].XValueMember = "Name"; chart1.Series[0].YValueMembers = "Price"; // Insert code for additional chart formatting here. chart1.DataBind();