Word Reports
GenerateWordReport(String,String,Dictionary<String,ReplacementItem>) Method
Example 



KellermanSoftware.WordReports Namespace > WordReportsGenerator Class > GenerateWordReport Method : GenerateWordReport(String,String,Dictionary<String,ReplacementItem>) Method
The path to a docx file to use as a template for the report
The output path for the docx file
Replacement values
Replace items in the source document and create a new word document
Syntax
Public Overloads Sub GenerateWordReport( _
   ByVal sourceDocumentPath As String, _
   ByVal outputDocumentPath As String, _
   ByVal replacement As Dictionary(Of String,ReplacementItem) _
) 
Dim instance As WordReportsGenerator
Dim sourceDocumentPath As String
Dim outputDocumentPath As String
Dim replacement As Dictionary(Of String,ReplacementItem)
 
instance.GenerateWordReport(sourceDocumentPath, outputDocumentPath, replacement)

Parameters

sourceDocumentPath
The path to a docx file to use as a template for the report
outputDocumentPath
The output path for the docx file
replacement
Replacement values
Example
//To run this example code, create a word document called ExampleTemplate.docx with the text [ReplaceMe] in the document
 
WordReportsGenerator generator = new WordReportsGenerator(); //Trial Mode
//WordReportsGenerator generator = new WordReportsGenerator("place user name here", "place license key here"); //License Mode
 
const string sourceDocumentPath = @"Test Documents\ExampleTemplate.docx";
const string outputDocumentPath = "ExampleOutput.docx";
 
Dictionary<string, ReplacementItem> replacement =
    new Dictionary<string, ReplacementItem>
        {
            {
                "[ReplaceMe]",
                new ReplacementItem { Value = "This is a test" }
            }
        };
 
generator.GenerateWordReport(sourceDocumentPath,
                              outputDocumentPath,
                              replacement);
'To run this example code, create a word document called ExampleTemplate.docx with the text [ReplaceMe] in the document
 
Dim generator As New WordReportsGenerator() 'Trial Mode
'WordReportsGenerator generator = new WordReportsGenerator("place user name here", "place license key here"); //License Mode
 
Const sourceDocumentPath As String = "Test Documents\ExampleTemplate.docx"
Const outputDocumentPath As String = "ExampleOutput.docx"
 
Dim replacement As New Dictionary(Of String, ReplacementItem)() From {{ "[ReplaceMe]", New ReplacementItem With {.Value = "This is a test"} }}
 
generator.GenerateWordReport(sourceDocumentPath, outputDocumentPath, replacement)
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

WordReportsGenerator Class
WordReportsGenerator Members
Overload List