.
Introduced in build 7.1.0.1855
Description
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.
C#
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) |
Sets a SharePoint List as a template data source. |
| Sets a SharePoint View as a template data source. | |
BindRowData(ExcelTemplate, Microsoft.SharePoint.SPList, String, DataBindingProperties) |
Sets a SharePoint List as a data source for a single row in a template. |
| Sets a SharePoint View as a data source for a single row in a template. | |
| Imports data from a SharePoint List to the specified Area. The new data will overwrite values and formulas in the target worksheet cells, but existing formatting will be preserved. | |
ImportData(Area, Microsoft.SharePoint.SPList, DataImportProperties) |
Imports data from a SharePoint List to the specified Area. The new data will overwrite values and formulas in the target worksheet cells, but existing formatting will be preserved. |
ImportData(Area, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataImportProperties) |
Imports data from a SharePoint View to the specified Area. The new data will overwrite values and formulas in the target worksheet cells, but existing formatting will be preserved. |
ImportData(Area, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList) |
Imports data from a SharePoint View to the specified Area. The new data will overwrite values and formulas in the target worksheet cells, but existing formatting will be preserved. |
| Imports data from a SharePoint List to cells in the worksheet. The new data will overwrite values and formulas in the target worksheet cells, but existing formatting will be preserved. | |
ImportData(Worksheet, Cell, Microsoft.SharePoint.SPList, DataImportProperties) |
Imports data from a SharePoint List to cells in the worksheet. The new data will overwrite values and formulas in the target worksheet cells, but existing formatting will be preserved. |
| Imports data from a SharePoint View to cells in the worksheet. The new data will overwrite values and formulas in the target worksheet cells, but existing formatting will be preserved. | |
ImportData(Worksheet, Cell, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList) |
Imports data from a SharePoint View to cells in the worksheet. The new data will overwrite values and formulas in the target worksheet cells, but existing formatting will be preserved. |
Open(ExcelApplication, Microsoft.SharePoint.SPDocumentLibrary, String) |
Opens an existing Excel spreadsheet from a SharePoint Document Library. |
Open(ExcelApplication, Microsoft.SharePoint.SPListItem, String) |
Opens an existing Excel spreadsheet that is attached to a SharePoint List Item. |
Open(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String) |
Opens a spreadsheet from a SharePoint Document Library. |
Open(ExcelTemplate, Microsoft.SharePoint.SPListItem, String) |
Opens a spreadsheet from a SharePoint List Item. |
Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPListItem, String) |
Saves a specified Workbook as a BIFF8 format (Excel 97 or later) .xls file. |
Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean) |
Saves a specified Workbook as a BIFF8 format (Excel 97 or later) .xls file. |
Save(ExcelTemplate, Microsoft.SharePoint.SPListItem, String) |
Generates an Excel binary or OOXML file and saves it as an attachment to a SharePoint list item. |
Save(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean) |
Generates an Excel binary or OOXML file and saves it to a SharePoint Document Library. |