.
Table of Contents |
|---|
Introduced in build 4.1.0.1379
Description
The SharePointIntegration class contains the extension methods that allow users to bind SharePoint data sources to Word documents 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 WordTemplate, WordApplication, and Element objects with SharePoint. SharePointIntegration belongs to the SoftArtisans.OfficeWriter.WordWriter namespace and has the Microsoft.SharePoint class as a dependency. Additionally, the SharePointIntegration class belongs in a separate DLL, SoftArtisans.OfficeWriter.WordWriter.SharePointIntegration.dll, which must be added to the bin directory of your project.Examples
SharePointIntegration is an abstract class which cannot directly be instantiated, but rather contains extension methods for the WordApplication, WordTemplate, and Element objects. Use SharePointIntegration extensions just as you would the other methods of each object, remembering to add references to the Microsoft.SharePoint namespace.Methods
Name |
Description |
|---|---|
ImportData(Element, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataBindingProperties) |
The page SharePointIntegration.ImportData(Element, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, DataBindingProperties) could not be found. |
| Imports the data from a SharePoint List into a Table at the point of the current element in the document. | |
Open(WordApplication, Microsoft.SharePoint.SPDocumentLibrary, String) |
Opens and returns an existing Document from a SharePoint Document Library. |
Open(WordApplication, Microsoft.SharePoint.SPListItem, String) |
Opens and returns an existing Document from a SharePoint List Item. |
Open(WordTemplate, Microsoft.SharePoint.SPDocumentLibrary, String) |
Opens the WordWriter template specified by the templateFileName parameter. |
Opens the WordWriter template specified by the templateFileName parameter. |
|
Save(WordApplication, Document, Microsoft.SharePoint.SPListItem, String) |
Writes a Document to a file and saves it to a SharePoint List Item. |
Save(WordApplication, Document, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean) |
Writes a Document to a file and saves it to a SharePoint Document Library. |
| Saves the generated Word file to a SharePoint List Item. | |
Save(WordTemplate, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean) |
Saves the generated Word file to a SharePoint Document Library. |
SetDataSource(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String) |
Sets a main document data source to a SharePoint View. If the specified View contains more than one row, WordWriter will use the first row as the data source. |
SetDataSource(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList) |
Sets a main document data source to a SharePoint View. If the specified View contains more than one row, WordWriter will use the first row as the data source. |
SetDataSource(WordTemplate, Microsoft.SharePoint.SPList, String) |
Sets a main document data source to a SharePoint List. If the specified List contains more than one row, WordWriter will use the first row as the data source. |
| Sets a main document data source to a SharePoint List. If the specified List contains more than one row, WordWriter will use the first row as the data source. | |
SetMailMerge(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, Integer) |
The page SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, Integer) could not be found. |
SetMailMerge(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList) |
Sets the MailMerge's data source to a SharePoint View. A MailMerge by default treats the page content as a repeat block, repeating the page content for each row unless NEXT fields are used. If the WordTemplate.EnableNEXTFields property is set to true, the NEXT field can also be used to indicate that the next row of data should be inserted instead of the current row at the next occurence of the merge fields. |
SetMailMerge(WordTemplate, Microsoft.SharePoint.SPList, Integer) |
The page SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPList, Integer) could not be found. |
| Sets the MailMerge's data source to a SharePoint View. A MailMerge by default treats the page content as a repeat block, repeating the page content for each row unless NEXT fields are used. If the WordTemplate.EnableNEXTFields property is set to true, the NEXT field can also be used to indicate that the next row of data should be inserted instead of the current row at the next occurence of the merge fields. | |
SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, Int) |
The page SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, Int) could not be found. |
SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String) |
Sets the specified repeat block's data source to a SharePoint View. |
SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPList, String, Int) |
The page SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPList, String, Int) could not be found. |
SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPList, String) |
Sets the specified repeat block's data source to a SharePoint List. |