DataBind Charts to SharePoint Data

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SharePoint ADO.NET Provider

Provides .NET developers with the power to easily connect their Web, Desktop, and Mobile applications to data in SharePoint Server Lists, Contacts, Calendar, Links, Tasks, and more!



Use the standard ADO.NET procedures for databinding to provide bidirectional access to SharePoint 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 SharePoint to easily databind SharePoint data to Windows Forms and Web controls in Visual Studio. This article shows how to use wizards to databind SharePoint 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 SharePoint. In the wizard, you can select the SharePoint 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 SharePoint Data Source.

    Below is a typical connection string:

    User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;

    Set the URL property to the base SharePoint site or to a sub-site. This allows you to query any lists and other SharePoint entities defined for the site or sub-site.

    The User and Password properties, under the Authentication section, must be set to valid SharePoint user credentials when using SharePoint On-Premise.

    If you are connecting to SharePoint Online, set the SharePointEdition to SHAREPOINTONLINE along with the User and Password connection string properties. For more details on connecting to SharePoint Online, see the "Getting Started" chapter of the help documentation

    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.

  5. Choose the database objects you want to work with. This example uses the MyCustomList 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 Revenue.

  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 data. Run the chart to display the current data.

Code Walk-through

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

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

SharePointConnection conn = new SharePointConnection("User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;"); SharePointCommand comm = new SharePointCommand("SELECT Name, Revenue FROM MyCustomList", conn); SharePointDataAdapter da = new SharePointDataAdapter(comm); DataSet dataset = new DataSet(); da.Fill(dataset); chart1.DataSource = dataset; chart1.Series[0].XValueMember = "Name"; chart1.Series[0].YValueMembers = "Revenue"; // Insert code for additional chart formatting here. chart1.DataBind();