Connecting from Code

The CData ADO.NET Provider for Microsoft SharePoint Excel implements a standard DbConnection object in Microsoft SharePoint ExcelConnection. You can also use the Microsoft SharePoint ExcelConnectionStringBuilder to programmatically build, parse, and rebuild connection strings.

Creating Connection Objects

See Establishing a Connection for guides to defining the connection string and authenticating. Below is a typical invocation to create Microsoft SharePoint ExcelConnection objects.

using (Microsoft SharePoint ExcelConnection connection =   
  new Microsoft SharePoint ExcelConnection("Url=https://myorg.sharepoint.com;User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;"))  
{  
  connection.Open();  
}

VB.NET

Using connection As New Microsoft SharePoint ExcelConnection("Url=https://myorg.sharepoint.com;User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;")
  connection.Open
End Using

Using Microsoft SharePoint ExcelConnectionStringBuilder

The following code example shows how to use an ADO.NET connection string builder to parse a connection string.

Microsoft SharePoint ExcelConnectionStringBuilder builder =
  new Microsoft SharePoint ExcelConnectionStringBuilder("Url=https://myorg.sharepoint.com;User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;");
  //Pass the connection string builder an existing connection string, and you can get and set any of the elements as strongly typed properties.
  builder.ConnectionString = "Url=https://myorg.sharepoint.com;User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;";
  //Now that the connection string has been parsed,
  // you can work with individual items:
  builder.MyString = "new property";
  builder.MyBoolean = true;

  // You can refer to connection keys using strings, 
  // as well. 
  builder["Logfile"] = "test.log";
  builder["Verbosity"] = 5;

VB.NET

Dim builder As Microsoft SharePoint ExcelConnectionStringBuilder = New Microsoft SharePoint ExcelConnectionStringBuilder("Url=https://myorg.sharepoint.com;User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;")
'Pass the connection string builder an existing connection string, and you can get and set any of the elements using strongly typed properties.
builder.ConnectionString = Url=https://myorg.sharepoint.com;User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;"
'Now that the connection string has been parsed,
' you can work with individual items:
builder.MyString = "new property"
builder.MyBoolean = True
  
' You can refer to connection keys using strings, 
' as well. 
builder("Logfile") = "test.log"
builder("Verbosity") = 5