DataBind Charts to SharePoint Excel Services Data

DataBinding facilitates two-way interaction with data through UI controls. Using the CData ADO.NET Provider for SharePoint Excel Services streamlines the process of binding SharePoint Excel Services data to Windows Forms and Web controls within Visual Studio. In this article, we will demonstrate using wizards to establish a binding between SharePoint Excel Services data and a chart that dynamically updates. Additionally, the code walk-through section will guide you through the creation of a chart using just 10 lines of code.

Binding Data to a Chart

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

Configure the Connection and Select Database Objects

To create a chart control and establish a connection to SharePoint Excel Services, follow the steps outlined below using the Data Source Configuration Wizard. Within the wizard, you'll have the option to choose the specific SharePoint Excel Services entities you wish to bind to.

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. 👁 Add a data source to be bound to the chart.
   
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 SharePoint Excel Services Data Source.

   Below is a typical connection string:

   URL=https://myorg.sharepoint.com;[email protected];Password=password;File=Book1.xlsx;

   The URL, User, and Password properties, under the Authentication section, must be set to valid credentials for SharePoint Online, SharePoint 2010, or SharePoint 2013. Additionally, the Library property must be set to a valid SharePoint Document Library and the File property must be set to a valid .xlsx file in the indicated Library.

   When you configure the connection, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   👁 Connection properties for the selected data source in the Add Connection dialog. (Salesforce is shown.)
   
5. Choose the database objects you want to work with. This example uses the Account table. 👁 Select database objects. (Salesforce is shown.)
   

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 AnnualRevenue.

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 SharePoint Excel Services data. Run the chart to display the current data. 👁 The chart, filled with data at run time.

Code Walk-through

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

1. Connect to SharePoint Excel Services.
2. Create the ExcelServicesDataAdapter 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:

ExcelServicesConnection conn = new ExcelServicesConnection("URL=https://myorg.sharepoint.com;[email protected];Password=password;File=Book1.xlsx;");
ExcelServicesCommand comm = new ExcelServicesCommand("SELECT Name, AnnualRevenue FROM Account", conn);
ExcelServicesDataAdapter da = new ExcelServicesDataAdapter(comm);
DataSet dataset = new DataSet();
da.Fill(dataset);

chart1.DataSource = dataset; 
chart1.Series[0].XValueMember = "Name";
chart1.Series[0].YValueMembers = "AnnualRevenue";
// Insert code for additional chart formatting here.
chart1.DataBind();