Connect to SharePoint Excel Services Data from Blazor Apps

Blazor is a framework for developing modern, client-side web UIs using .NET technology. Instead of coding in JavaScript, developers can use the familiar C# language and .NET libraries to build app UIs.

The CData ADO.NET Provider for SharePoint Excel Services can be used with standard ADO.NET interfaces, such as LINQ and Entity Framework, to interact with live SharePoint Excel Services data. Since Blazor supports .NET Core, developers can use CData ADO.NET Providers in Blazor apps. In this article, we will guide you to build a simple Blazor app that talks to SharePoint Excel Services using standard SQL queries.

Install the CData ADO.NET Provider for SharePoint Excel Services

CData ADO.NET Providers allow users to access SharePoint Excel Services just like they would access SQL Server, using simple SQL queries.

Install the SharePoint Excel Services ADO.NET Data Provider from the CData website or from NuGet. Search NuGet for "SharePoint Excel Services ADO.NET Data Provider."

Create a SharePoint Excel Services-Connected Blazor App

Start by creating a Blazor project that references the CData ADO.NET Provider for SharePoint Excel Services

1. Create a Blazor project on Visual Studio.
2. From the Solution Explorer, right click Dependencies, then click Add Project Reference.
3. In the Reference Manager, click the Browse button, and choose the .dll file of the installed ADO.NET Provider (e.g. System.Data.CData.ExcelServices.dll, typically located at C:\Program Files\CData\CData ADO.NET Provider for SharePoint Excel Services\lib etstandard2.0).

SELECT SharePoint Excel Services Data from the Blazor App

1. Open the Index.razor file from the Project page.
2. In a ExcelServicesConnection object, set the connection string:

   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.

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

3. The code below creates a simple Blazor app for displaying SharePoint Excel Services data, using standard SQL to query SharePoint Excel Services just like SQL Server.

         @page "/"
         @using System.Data;
         @using System.Data.CData.ExcelServices;
         
         <h1>Hello, world!</h1>
         
         Welcome to your Data app.
         
         <div class="row">
             <div class="col-12">
         
                 @using (ExcelServicesConnection connection = new ExcelServicesConnection(
                   "URL=https://myorg.sharepoint.com;[email protected];Password=password;File=Book1.xlsx;"))
                 {
                     var sql = "SELECT Name, AnnualRevenue FROM Account";
                     var results = new DataTable();
         
                     ExcelServicesDataAdapter dataAdapter = new ExcelServicesDataAdapter(sql, connection);
                     dataAdapter.Fill(results);
         
                     <table class="table table-bordered">
                         <thead class="thead-light">
                             <tr>
                                 @foreach (DataColumn item in results.Rows[0].Table.Columns)
                                 {
                                     <th scope="col">@item.ColumnName</th>
                                 }
                             </tr>
                         </thead>
                         <tbody>
                             @foreach (DataRow row in results.Rows)
                             {
                                 <tr>
                                     @foreach (var column in row.ItemArray)
                                     {
                                         <td>@column.ToString()</td>
                                     }
                                 </tr>
                             }
                         </tbody>
                     </table>
                 }
             </div>
         </div>
       

4. Rebuild and run the project. The ADO.NET Provider renders SharePoint Excel Services data as an HTML table in the Blazor app.

   At this point, you have a SharePoint Excel Services-connected Blazor app, capable of working with live SharePoint Excel Services data just like you would work with a SQL Server instance. Download a free, 30-day trial and start working with live SharePoint Excel Services data in your Blazor apps today.