Windward Documentation.NET Report Engine User Manual Reference.NET Report Engine app.exe.config Settings

.NET Report Engine app.exe.config Settings

This article describes the optional properties that can be placed in your .NET Report Engine application's app.exe.config file.

Place these properties into the "WindwardReports" section of the app.exe.config file, e.g.:

<configuration>
    <configSections>
        <section name="WindwardReports" type="System.Configuration.NameValueSectionHandler" />
    </configSections>
    <WindwardReports>
        <add key="license" value="EnterKeyHere" />
    </WindwardReports>
</configuration>

Properties Categories

The below property settings fall into three general categories:

  1. Read in and set when the Report Engine starts. You need to restart the Report Engine for new values to be read and used. These properties are categorized as Global.
  2. Read in and used every time a output is generated from a Report Template. When these are changed, the next report will use the new settings. These properties are categorized as Local.
  3. Default values for properties you can set in a (Process)Report object. When you change these the next instantiation of the report object will use those new values as the defaults. You can then explicitly set these properties in the object. These properties are categorized as Report.
  4. Other properties that don't fall into the above categories are categorized as Miscellaneous.

Use these links to jump forward to a properties category:

Global Properties

Local Properties

Report Properties

Miscellaneous Properties

Global Properties

Name Allowed Values Default Description
asian.support
true, false
true
If set to false, the server assumes the files needed for output of Asian text is not available and will fall-back to latin text only.
default.chart.dpi
any number
300
When charts are rendered to a bitmap (for printers), they are rendered at this resolution.
default.image.dpi any number
96
If a bitmap does not have it's DPI set, this is the value used.
expand.out.text
ignore, newline, paragraph
paragraph
What to do if an Out Tag has a <CR> and/or <TAB> in the text. Choices are ignore, newline, or paragraph. <TAB> is handled for both newline and paragraph. newline is a line break (like <br/> in html) and paragraph is a paragraph break.
font.files
fontname; fontname;…
none
Example: C:/windows/fonts/*.ttf;c:/windows/fonts/*.ttc;
A series of pathnames, separated by semicolons, of true type fonts installed on the system. The only wildcard recognized is the "*" (i.e. no regular expressions). The Report Engine will look in the usual directories on Windows & Linux; this setting is just to include non-standard locations.
font.map
font_replace1=
font_substitute1;…
none

Example: Arial=Courier New;Times New Roman=Verdana

Map a font onto another. In the example above any use of Arial in the generated output will instead use Courier New. Any use of Times New Roman will instead use Verdana. Very useful when a template uses fonts that do not exist on the system the engine is running on.

force.bitmap.format
bmp, gif, jpeg, png, & tiff
none This will force all bitmaps in the Report Template output to be converted to the requested format. The default is no conversion.
ignore.tag.colors
true, false
false
Set to false to remove foreground colors from Tags if the color of the Tag in the template matches the Tag's assigned color.
layout.document on, off
on
If set to off, then page layout for output of type DOCX, XLSX, PPTX and HTML in non-pages mode, will not be performed. The advantage of turning this off is that document production will be faster. This setting is ignored for other output types.
license a valid Windward license
none
This is required for the .NET Report Engine – it is your license to run the program. It is a uuencoded string and can be in a single line or in multiple lines. If multiple lines, do not put spaces at the beginning/end of the lines.
logging.filename off, a log4j properties filename
none
The location of your log4j properties file. If you use log4j for your application, put the properties file location here. The value of off means you are not using log4j. There is no need to set this if log4j is initialized before Windward Reports is called.
odata.max-message-size Any number
10000000
Set the maximum message size in the OData provider.
pdf.font_mapping auto, postscriptFont1=
displayFont1;…
none
Can be set to auto or ArialMT=Arial;Arial-BoldMT=Arial,Bold; auto will set the font names to the names specified in the Report Template, overwriting the true postscript name. The series of "postscriptFont=displayFont;" is an explicit mapping and you can have as many as you wish.
pdf.makeLineToFit true, false
true
Set to true to force PDF text to fit within the Report Engine-calculated width. Set to false to fit the text within the width Acrobat calculates.
pdf.rgbTransparencyBlendingSpace true, false
false
Set to false to turn off using the RGB space for image color blending in PDF output.
system.locale any locale such as de or de_CH
the system locale
Set the locale for system messages.

Local Properties

Name Allowed Values Default Description
check.for.glyphs
on, off
on
Checks the font specified for text and changes the font if it does not have glyphs for some of the text.
check.for.glyphs.fontnames
font name 1;font name 2;…
MS Mincho;Arial Unicode MS
The list of fonts to consider when the specified font does not have the glyphs needed. The font with the largest number of needed glyphs is used. If more than one font has the largest number, the earliest font in the list is used.
check.for.ole.images true, false
true
If true, the Report Engine will check all images brought in via an Out Tag for an OLE header (used in Northwind & Access databases), and will strip it off. Non-OLE images are not affected.
html.embed_images true, false
false
If set to true, embeds images in HTML output. If set to false, separate image files are output.
html.split_pages true, false
false
Set to true to output multiple files, one HTML file per document page. Set to false to create one continuous HTML page.
line.break internal, external
internal

Set to internal to use the Windward Reports internal line breaker. Set to external to use the Java or .NET runtime line breaker.

The Windows default is external; the default for other operating systems is internal. Use internal for hyphenation, small caps, font scaling and font spacing for PDF and printer output.

report.hyphenate 0, 1, or 2
1
Use to hyphenate generated output. 0: do not hyphenate; 1: hyphenate if auto-hyphenate is set in the Report Template; 2: hyphenate.
report.remove-unused-formats true, false
false
Set to true to remove unused formats (Word only).
report.timeout any number (in seconds) greater than 0
none
If a report takes longer than this time (+/- 15 seconds) to generate, it will throw an exception.
report.trim none, end.whitespace, and end.blank
none
Use this to trim whitespace at the end of a report. end.whitespace will remove empty paragraphs and section breaks. end.blank will also remove blank text.
report.write-fields-as-fields true, false
true
If true, DOCX form fields and content controls are written to PDF and HTML output as form fields. If false, they are written as text.
sql.smart-quote true, false
false
If set to true, a '${var}' will be changed to ? instead of the regular substitution of '?'.
sql.timeout
any number 0 or greater
Whatever the underlying data connector (ADO.NET) has as a default.
Set the timeout on SQL selects in the underlying SQL connector. A value of 0 is infinite and is NOT recommended.
trim.tables aggressively
aggressively
For Excel only - it will remove empty rows at the bottom of the table and empty columns on the right side of rows. It will remove formatted cells, but it will not remove cells with content or that are merged with other cells.
txt.font_name any valid font name
Courier (Courier New on Windows)
Use this font instead of Courier to calculate text placement in Report Template output.
txt.font_size 6 - 256
12
Use this font size instead of 12pt to calculate text placement in Report Template output.
use.decimal true, false
false
Set to true to use BigDecimal instead of Double in the Windward functions. Useful in cases when String to Double rounding errors occur.
word.version 2007, 2010, 2013, 2016
2016
The Report Template will be parsed using the default values for this version of Word.
write.tags 0, 1, 2
2
When generating output with Tags without a data source applied, it will output the Tags in the following format: 0: text; 1: field (Word), Report Designer macro (Excel), text (PPT); 2: field, bitmap/chart for Tags that produce a bitmap or chart (Word only).

Report Properties

Name Allowed Values Default Description
csv.cell_separator
any string
, In CSV reports, this changes the separator between cells from "," to the specified string.
csv.quote_char
any string
" In CSV reports, changes the quote delimiter from " to this string.
csv.newline
any string
\r\n
In CSV reports, changes the new line string from \r\n (carriage return, line feed) to this string.
csv.trim_whitespace
true, false
false
In CSV reports, if set to true, this will trim all whitespace at the end of cell contents in all cells.
html.full_file true, false
true
The default value for ProcessOpenXmlAPI.getFullFile(). This can be overridden with a programatic call to Report.setFullFile().
html.html_type
see setSpec()
see setSpec()
The default value for ProcessOpenXmlAPI.getSpec().This can be overridden with a programatic call to Report.setSpec().
openxml.copy-drawings
true, false
true
The default value for ProcessOpenXmlAPI.getCopyDrawings(). This can be overridden with a programatic call to Report. setCopyDrawings().
openxml.copy-embedded-objects true, false
true
The default value for ProcessOpenXmlAPI.getCopyEmbeddedObjects(). This can be overridden with a programmatic call to Report.setCopyEmbeddedObjects().
openxml.copy-metadata
see setCopyMetadata()
2 The default value for ProcessOpenXmlAPI.getCopyMetadata(). This can be overridden with a programmatic call to Report.setCopyMetadata().
openxml.copy-shapes true, false
true
The default value for ProcessOpenXmlAPI.getCopyShapes(). This can be overridden with a programmatic call to Report.setCopyShapes().
openxml.recalculate true, false
true for XLSX; false for DOCX and PPTX
The default value for ProcessOpenXmlAPI.getRecalculateOnOpen(). This can be overridden with a programmatic call to Report.setRecalculateOnOpen().
openxml.write-chart-as-chart true, false
true
The default value for ProcessOpenXmlAPI.getChartsAsCharts().This can be overridden with a programatic call to Report.setChartsAsCharts().
pdf.compression_level 0, 1, or 2
1
The default value for ReportPdf.getCompressionLevel().This can be overridden with a programmatic call to ReportPdf.setCompressionLevel().
pdf.font_level
0, 1, or 2
2

This is the default value for ProcessPdf.setFontLevel(). You must use the number of the static final int specified in ProcessPdf. This can still be overridden with a programmatic call to ProcessPdf.setFontLevel().

pdf.key_length
40 or 128
40
The default value for ReportPdf.getKeyLength(). This can be overridden with a programmatic call to ReportPdf.setKeyLength().
pdf.owner_password any string
none
The default value for ReportPdf.getOwnerPassword().This can be overridden with a programmatic call to ReportPdf.setOwnerPassword().
pdf.PDF_A on, off
off
The default value for ReportPdf.isPdfA(). This can be overridden with a programmatic call to ReportPdf.setPdfA().
pdf.security see getSecurity()
0
The default value for ReportPdf.getSecurity(). This can be overridden with a programmatic call to ReportPdf.setSecurity().
pdf.user_password
any string
none
The default value for ReportPdf.getUserPassword().This can be overridden with a programmatic call to ReportPdf.setUserPassword().
report.hidden.mode see Report.setHiddenMode()
0
The default for Report.getHiddenMode(). This can be overridden with a programmatic call to Report.setHiddenMode().
report.locale any locale string
the system locale
The default value for Report.setLocale(). You must use either a language (en) or language_country (en_US). This can be overridden with a programmatic call to Report.setLocale(). This is the locale used when generating output for things like the default formatting of a currency amount.
report.locale_asian
any locale string
the system locale for East Asian content
Similar to report.locale except used when content for a Tag is marked as East Asian.
report.locale_bidi any locale string
the system locale for bidi content
Similar to report.locale except used when content for a Tag is marked as bi-directional, e.g. ar_SA.
txt.break_page
true, false
false
The default value for ProcessText.getBreakPage(). This can be overridden with a programmatic call to ReportPdf.setBreakPage().
txt.show_headers true, false
false
The default value for ProcessText.getShowHeaders(). This can be overridden with a programmatic call to ReportPdf.setShowHeaders().
txt.use_margins true, false
false
The default value for ProcessText.getUseMargins(). This can be overridden with a programmatic call to ReportPdf.setUseMargins().
txt.use_soft_eoln
true, false
false
The default value for ProcessText.getUseSoftEoln(). This can be overridden with a programatic call to ReportPdf.setUseSoftEoln().

Miscellaneous Properties

Name Allowed Values Default Description
import.use.child.styles
true, false
true
(Version 13.x only. For applying/importing parent styles in versions 14.x and later, see Import Tag Reference.) When an imported template's style settings don't match the master document this determines if default settings in the imported document will match the imported style (true) or the master style (false).
sql.parameters
substitution, parameters or parameters.always
parameters
Sets the default value in DataSourceProvider.setParamMode().
use.parent.format
true, false
false
(Version 13.x only. For applying/importing parent styles in versions 14.x and later, see Import Tag Reference.) This sets the default value for the Import Tag use-parent-format property. The default is false and does nothing. If set to true, then imported templates will have their first paragraph and character formatting set to that of the paragraph in the parent template where the Import Tag is located.

ImportFileClass

Use the ImportFileClass if you have a method for accessing files and/or security protocols that is not supported by Windward. See that attached file for a sample implementation

In the app.exe.config file you can set the property ImportFileClass. You set it to the classname of the class you implement. For example, you can set:

ImportFileClass=net.windward.env.StandardImportFile

If that class exists, it will be used instead of the default class (which is net.windward.env.StandardImportFile). This class must be available to the Report Engine so it must be loaded with your application. The class must implement ImportFile. It has a single method that is passed the information of the file you wish to import and it returns the imported file.

0 Comments

Add your comment

E-Mail me when someone replies to this comment