How to Specify PDF Builder for Output

We offer three different means of generating PDF output through our engines: our internal Windward PDF renderer, Microsoft Office PDF and PdfTron.   We use our internal PDF render by default. Here are the instructions on how to specify which PDF builder you want yo use for output.

.NET Engine

You can specify the output builder in the RunReport.exe.config  file to set it globally for all reports. To do that set these properties:

  • For PdfTron builder:
<WindwardReports>
 <add key="use.external.output.builder" value="on" />  
 <add key="output.builder" value="net.windward.env.PDFTronOutputBuilder" /> 
</WindwardReports> 
  • For Microsoft Office PDF builder:
<WindwardReports>
 <add key="use.external.output.builder" value="on" />  
 <add key="output.builder" value="net.windward.env.OfficeOutputBuilder" />
</WindwardReports> 

(If you want to use the internal Windward PDF renderer, dont change the configurations)


You can also specify the PDF builder on a per request basis programmatically if you are using the .NET Engine API.

  • For PdfTron builder:
Report report = new ReportPdf(...) 
...
report.OutputBuilder = new PDFTronOutputBuilder(); report.UseExternalOutputBuilder = true; 
  • For Microsoft Office builder:
Report report = new ReportPdf(...) 
...
report.OutputBuilder = new OfficeOutputBuilder(); report.UseExternalOutputBuilder = true; 

.NET RESTful Engine

If you use the .NET RESTful engine, you can specify your desired PDF builder in the Web.config file. To do so set these properties:

  • For PdfTron builder:
<WindwardReports>
 <add key="use.external.output.builder" value="on" />  
 <add key="output.builder" value="net.windward.env.PDFTronOutputBuilder" /> 
</WindwardReports> 
  • For Microsoft Office PDF builder:
<WindwardReports>
 <add key="use.external.output.builder" value="on" />  
 <add key="output.builder" value="net.windward.env.OfficeOutputBuilder" />
</WindwardReports> 

Java Engine

You can specify the output builder in the WindwardReports.properties file to set it globally for all reports. To do that set these properties:

  • For PdfTron builder:
use.external.output.builder=true
output.builder=net.windward.env.PDFTronOutputBuilder
  • For Microsoft Office PDF builder:
use.external.output.builder=true
output.builder=net.windward.env.OfficeOutputBuilder

(If you want to use the internal Windward PDF renderer, dont change the configurations)


You can also specify the PDF builder on a per request basis programmatically if you are using the Java Engine API.

  • For PdfTron builder:
ProcessReport process = new ProcessPdf(...)
...
IOutputBuilderEngine builder = new PDFTronOutputBuilder();
process.setOutputBuilder(builder);
process.setUseExternalOutputBuilder(true);
  • For Microsoft Office builder:
ProcessReport process = new ProcessPdf(...)
...
IOutputBuilderEngine builder = new OfficeOutputBuilder();
process.setOutputBuilder(builder);
process.setUseExternalOutputBuilder(true);

0 Comments

Add your comment

E-Mail me when someone replies to this comment