Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added vb signature

Introducedin
7.1.0.1855
7.1.0.1855
Description

Excerpt

The SharePointIntegration class contains the extension methods that allow users to bind SharePoint data sources to Excel spreadsheets as well as open and save files in SharePoint lists and document libraries.

Signature
C#
C#

public static class SharePointIntegration
Signature
0vb
Public NotInheritable Class SharePointIntegration
Remarks

The SharePointIntegration class is to be used on a SharePoint server to use the ExcelTemplate, ExcelApplication, Worksheet, and Area objects with SharePoint. SharePointIntegration belongs to the SoftArtisans.OfficeWriter.ExcelWriter.SharePointIntegration namespace, which has the Microsoft.SharePoint class as a dependency. Additionally, the SharePointIntegration class belongs in a separate DLL, SoftArtisans.OfficeWriter.ExcelWriter.SharePoinIntegration.dll, which must be added to the bin directory of your project.

SharePointIntegration is a static class which cannot directly be instantiated, but rather contains extension methods for the ExcelApplication, ExcelTemplate, Worksheet, and Area objects. Use SharePointIntegration extensions just as you would the other methods of each object, remembering to add references to the SoftArtisans.OfficeWriter.ExcelWriter and Microsoft.SharePoint namespaces.

Methods

Name

Description

BindData(ExcelTemplate, Microsoft.SharePoint.SPList, String, DataBindingProperties)

Excerpt Include
SharePointIntegration.BindData(ExcelTemplate, Microsoft.SharePoint.SPList, String, DataBindingProperties)
SharePointIntegration.BindData(ExcelTemplate, Microsoft.SharePoint.SPList, String, DataBindingProperties)
nopaneltrue

BindData(ExcelTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)

Excerpt Include
SharePointIntegration.BindData(ExcelTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)
SharePointIntegration.BindData(ExcelTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)
nopaneltrue

BindRowData(ExcelTemplate, Microsoft.SharePoint.SPList, String, DataBindingProperties)

Excerpt Include
SharePointIntegration.BindRowData(ExcelTemplate, Microsoft.SharePoint.SPList, String, DataBindingProperties)
SharePointIntegration.BindRowData(ExcelTemplate, Microsoft.SharePoint.SPList, String, DataBindingProperties)
nopaneltrue

BindRowData(ExcelTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)

Excerpt Include
SharePointIntegration.BindRowData(ExcelTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)
SharePointIntegration.BindRowData(ExcelTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)
nopaneltrue

ImportData(Area, Microsoft.SharePoint.SPList)

Excerpt Include
SharePointIntegration.ImportData(Area, Microsoft.SharePoint.SPList)
SharePointIntegration.ImportData(Area, Microsoft.SharePoint.SPList)
nopaneltrue

ImportData(Area, Microsoft.SharePoint.SPList, DataImportProperties)

Excerpt Include
SharePointIntegration.ImportData(Area, Microsoft.SharePoint.SPList, DataImportProperties)
SharePointIntegration.ImportData(Area, Microsoft.SharePoint.SPList, DataImportProperties)
nopaneltrue

ImportData(Area, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataImportProperties)

Excerpt Include
SharePointIntegration.ImportData(Area, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataImportProperties)
SharePointIntegration.ImportData(Area, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataImportProperties)
nopaneltrue

ImportData(Area, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)

Excerpt Include
SharePointIntegration.ImportData(Area, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)
SharePointIntegration.ImportData(Area, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)
nopaneltrue

ImportData(Worksheet, Cell, Microsoft.SharePoint.SPList)

Excerpt Include
SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPList)
SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPList)
nopaneltrue

ImportData(Worksheet, Cell, Microsoft.SharePoint.SPList, DataImportProperties)

Excerpt Include
SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPList, DataImportProperties)
SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPList, DataImportProperties)
nopaneltrue

ImportData(Worksheet, Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataImportProperties)

Excerpt Include
SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataImportProperties)
SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataImportProperties)
nopaneltrue

ImportData(Worksheet, Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)

Excerpt Include
SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)
SharePointIntegration.ImportData(Worksheet, Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)
nopaneltrue

Open(ExcelApplication, Microsoft.SharePoint.SPDocumentLibrary, String)

Excerpt Include
SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPDocumentLibrary, String)
SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPDocumentLibrary, String)
nopaneltrue

Open(ExcelApplication, Microsoft.SharePoint.SPListItem, String)

Excerpt Include
SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPListItem, String)
SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPListItem, String)
nopaneltrue

Open(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String)

Excerpt Include
SharePointIntegration.Open(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String)
SharePointIntegration.Open(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String)
nopaneltrue

Open(ExcelTemplate, Microsoft.SharePoint.SPListItem, String)

Excerpt Include
SharePointIntegration.Open(ExcelTemplate, Microsoft.SharePoint.SPListItem, String)
SharePointIntegration.Open(ExcelTemplate, Microsoft.SharePoint.SPListItem, String)
nopaneltrue

Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPListItem, String)

Excerpt Include
SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPListItem, String)
SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPListItem, String)
nopaneltrue

Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)

Excerpt Include
SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)
SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)
nopaneltrue

Save(ExcelTemplate, Microsoft.SharePoint.SPListItem, String)

Excerpt Include
SharePointIntegration.Save(ExcelTemplate, Microsoft.SharePoint.SPListItem, String)
SharePointIntegration.Save(ExcelTemplate, Microsoft.SharePoint.SPListItem, String)
nopaneltrue

Save(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)

Excerpt Include
SharePointIntegration.Save(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)
SharePointIntegration.Save(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)
nopaneltrue