Ready to get started?

Download a free trial of the SharePoint Excel Services Data Provider to get started:

 Download Now

Learn more:

SharePoint Excel Services Icon SharePoint Excel Services ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with live Excel Spreadsheet content hosted on SharePoint server!

Access SharePoint Excel Services Data with Entity Framework 6



This article shows how to access SharePoint Excel Services data using an Entity Framework code-first approach. Entity Framework 6 is available in .NET 4.5 and above.

Microsoft Entity Framework serves as an object-relational mapping framework for working with data represented as objects. Although Visual Studio offers the ADO.NET Entity Data Model wizard to automatically generate the Entity Model, this model-first approach may present challenges when your data source undergoes changes or when you require greater control over entity operations. In this article, we will delve into the code-first approach for accessing SharePoint Excel Services data through the CData ADO.NET Provider, providing you with more flexibility and control.

  1. Open Visual Studio and create a new Windows Form Application. This article uses a C# project with .NET 4.5.
  2. Run the command 'Install-Package EntityFramework' in the Package Manger Console in Visual Studio to install the latest release of Entity Framework.
  3. Modify the App.config file in the project to add a reference to the SharePoint Excel Services Entity Framework 6 assembly and 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.

    <configuration> ... <connectionStrings> <add name="ExcelServicesContext" connectionString="Offline=False;URL=https://myorg.sharepoint.com;User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;" providerName="System.Data.CData.ExcelServices" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.ExcelServices" type="System.Data.CData.ExcelServices.ExcelServicesProviderServices, System.Data.CData.ExcelServices.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
  4. Add a reference to System.Data.CData.ExcelServices.Entities.EF6.dll, located in the lib -> 4.0 subfolder in the installation directory.
  5. Build the project at this point to ensure everything is working correctly. Once that's done, you can start coding using Entity Framework.
  6. Add a new .cs file to the project and add a class to it. This will be your database context, and it will extend the DbContext class. In the example, this class is named ExcelServicesContext. The following code example overrides the OnModelCreating method to make the following changes:
    • Remove PluralizingTableNameConvention from the ModelBuilder Conventions.
    • Remove requests to the MigrationHistory table.
    using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class ExcelServicesContext : DbContext { public ExcelServicesContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<ExcelServicesContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
  7. Create another .cs file and name it after the SharePoint Excel Services entity you are retrieving, for example, Account. In this file, define both the Entity and the Entity Configuration, which will resemble the example below: using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; [System.ComponentModel.DataAnnotations.Schema.Table("Account")] public class Account { [System.ComponentModel.DataAnnotations.Key] public System.String Name { get; set; } public System.String AnnualRevenue { get; set; } }
  8. Now that you have created an entity, add the entity to your context class: public DbSet<Account> Account { set; get; }
  9. With the context and entity finished, you are now ready to query the data in a separate class. For example: ExcelServicesContext context = new ExcelServicesContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Account select line;