Wiki Markup |
---|
{introducedin:4.1.0.1379} {description} {excerpt}Sets the specified repeat block's data source to a SharePoint View. {excerpt} {signature:C#} public static void SetRepeatBlock(this WordTemplate template, Microsoft.SharePoint.SPView view, Microsoft.SharePoint.SPList list, string bookmark, int maxRows) {signature} {signature:vb.net} Public Shared Sub SetRepeatBlock(ByVal template As WordTemplate, ByVal view As Microsoft.SharePoint.SPView, ByVal list As Microsoft.SharePoint.SPList, ByVal bookmark As String, ByVal maxRows As Integer) {signature} {parameters} {param:template}The current WordTemplate object calling SetRepeatBlock{param} {param:view}The SharePoint View to use as the data source. {param} {param:list}The SharePoint List to which the View applies. {param} {param:bookmark}The bookmark name of the template repeat block. The bookmark passed to {{SetRepeatBlock}} must exist in the template Word file. To see a list of template bookmark names: # Open the template in Microsoft Word. # Open the *Edit* menu. # Select *Go To...* # Select *Bookmark*. # Under *Enter bookmark name*, open the drop\-down list of bookmark names. {param} {param:maxRows}Specifies the maximum number of repetitions to write to the file. If Next fields are enabled (see [EnableNEXTFields|WordTemplate.EnableNEXTFields]), then the number of rows imported from the data source is {{maxRows\*(numberOfNextFields\+1)}}. If Next fields are not enabled the number of rows imported is equal to the number of repetitions written out. To write the maximum rows available, use the constant [WordTemplate.ALL\_ROWS|WordTemplate.ALL_ROWS]. {param} {exceptions} {exception:ArgumentNullException}{{SetRepeatBlock}} will throw this exception if {{null}} \(C\#\) or {{Nothing}} \(VB.NET\) is passed to the method. {exception} {exception:ArgumentException} {exception} {remarks} A repeat block is a fragment in the template document that will be repeated for each row in a data source. In the template document, repeat blocks are defined by Word bookmarks that contain merge fields. You can call [SetRepeatBlock|WordTemplate.SetRepeatBlock] several times for a single instance of [WordTemplate]. The repeat block specified by the parameter {{bookmark}} must exist in the template. {note}This is an extension method for the WordTemplate object to be used for binding SharePoint data to applications from within SharePoint. To use this method, you must add a reference to SoftArtisans.OfficeWriter.WordWriter.SharePointIntegration.dll{note} {remarks} {example}{code:csharp|title=C#} //--- Set a data source for the repeat block //--- defined by the bookmark "Page" //--- "myView" is the SharePoint View containing the data to be //--- imported and repeated in the repeat block //--- Set MaxRows to 10. Only 10 rows from the SharePoint List //--- will be imported oWW.SetRepeatBlock(myView, myList, "Page", 10); oWW.Process(); {code} {code:vb.net|title=vb.net} '--- Set a data source for the repeat block '--- defined by the bookmark "Page" '--- "myView" is the SharePoint View containing the data to be '--- imported and repeated in the repeat block '--- Set MaxRows to 10. Only 10 rows from the SharePoint List '--- will be imported oWW.SetRepeatBlock(myView, myList, "Page", 10) oWW.Process() {code} {example} |
Page History
Overview
Content Tools