| | Name | Description |
|---|
 | BaseDirectory | The base directory used for relative files in the import tag. (Inherited from net.windward.api.csharp.Report) |
| CopyMetadata | Get/set if the Windward metadata will be copied to the generated report. This can only occur if the template and generated report are both OpenXML files. The default is IF_NO_DATASOURCE. (Inherited from net.windward.api.csharp.Report) |
| DataMode | As the report is run, the data for each tag can also be placed in an associated data.xml file. This xml will have a node for each tag and depending on the settings, the node will contain the tag attributes and/or the data extracted from the datasource for that tag. This data file can be returned to the caller and/or embedded in the generated report. The embed option is only for OpenXML and PDF reports. (Inherited from net.windward.api.csharp.Report) |
| DataProcessorVersion | Returns version of data processor being used by this report object. (Inherited from net.windward.api.csharp.Report) |
| DataStream | The stream to write the data.xml file to. As the report is run, the data for each tag can also be placed in an associated data.xml file. This xml will have a node for each tag and depending on the settings, the node will contain the tag attributes and/or the data extracted from the datasource for that tag. You may not set this if the DataMode includes DATA_MODE_EMBED. Setting this has no impact if DataMode == 0. You can only get the if DataMode != 0. If you did not set DataStream this will return a MemoryStream with the generated data.xml file in UTF-8. You should only call this after calling processComplete. (Inherited from net.windward.api.csharp.Report) |
| DebugHandler | The debug handler assigned to this report if debugging. (Inherited from net.windward.api.csharp.Report) |
| DebugMode | Set debug mode on or off. If debug mode is on, common user errors will be written to the report rather than throwing an exception. (Inherited from net.windward.api.csharp.Report) |
| Description | The description of the document. For Windward Scout reports only, this will be written to the run entry in the database. (Inherited from net.windward.api.csharp.Report) |
| Hyphenate | Get/set if the generated report will be hyphenated (for PDF output only). (Inherited from net.windward.api.csharp.Report) |
| ImportInfo | Get all imports in the processed template. This must be called after processData as that is what finds the imports. You must set TrackImports = true; before processing for this value to be populated. (Inherited from net.windward.api.csharp.Report) |
| IsChartsAsCharts | true if chart tags that are in the template as a chart, will be rendered as charts in the generated report. If * false, then charts will be generated as bitmaps. This setting is only for chart tags that are stored in the template as a chart. It is only relevant for output to OpenXML formats. (Inherited from net.windward.api.csharp.ReportOpenXml) |
| IsCopyDrawings | true if drawings are to be copied to output. Drawings are only copied for DOCX -> DOCX and XLSX -> XLSX. Default is true. (Inherited from net.windward.api.csharp.ReportOpenXml) |
| IsCopyShapes | true if shapes are to be copied to output. Shapes are only copied for DOCX -> DOCX and XLSX -> XLSX. Default is true. (Inherited from net.windward.api.csharp.ReportOpenXml) |
| IsRecalculateOnOpen | true if the document is to perform recalculation when first opened. (Inherited from net.windward.api.csharp.ReportOpenXml) |
| Keywords | The keywords of the document. This are delimited by a ','. In html this will set the keywords meta-tag. (Inherited from net.windward.api.csharp.Report) |
| License | Sets the license key for windward to do for this report. If set this license takes priority of the license key from the configuration file or the static Report.ApplyLicenseKey() method. (Inherited from net.windward.api.csharp.Report) |
| Locale | This call set's the locale used in creating a report. If not set, the default is not the system locale - it is the locale of the report template. This affects; 1) The output report locale for html and rtf reports, 2) The charset used for txt reports, 3) The rules used for soft line breaks (this mostly affects Thai), and 4) the locale used for <wr:out>. The passed in value can be any locale or the values LOCALE_DEFAULT or LOCALE_SYSTEM. LOCALE_DEFAULT will use the locale in the report template. LOCALE_DEFAULT will use the system locale. (Inherited from net.windward.api.csharp.Report) |
| ModeProcessEmbedded | What to do processing embedded objects. Writing an embedded object to the generated report can only be done for the case of DOCX -> DOCX and XLSX -> XLSX(and in the future, PPTX -> PPTX). But for any other case, the screenshot of the object can be written(except TXT and CSV obviously). So these settings are valid for all combinations, but implemented in the context of object -> bitmap. (Inherited from net.windward.api.csharp.Report) |
| NumPages | Returns how many pages long a report is. Can only be called after process completes. For html and text reports (which by definition are 1 page long) it will return the number of pages it would be if it was a paged report. (Inherited from net.windward.api.csharp.Report) |
| OutputBuilder | Set the output builder. Use this method instead of the properties file if you want to provide an object. This must be called after init. (Inherited from net.windward.api.csharp.Report) |
| OutputBuilderData | Data to pass to the output builder. For the embedded Windward builder this is either null or the Office Application object. (Inherited from net.windward.api.csharp.Report) |
| Parameters | Adds a map that is used for ${variable} substitution. The key values cannot have any of the characters ${} in them. When ${key} is found in any tag, it is replaced with the matching value. The key and value are not evaluated in any way, it is just a text substitution. This replace occurs before any other evaluation of a tag so the value can have ${variable} values that will then be evaluated. This call sets the map so calling it a second time replaces the map passed in the first time. The map is copied so on return changes to the passed in map will not affect the data source. You can pass in either DateTime or DateTime objects on the set call. However, when you call get, they will all be DateTimeOffset objects (the engine converts att DaleTime objects to DateTimeOffset). (Inherited from net.windward.api.csharp.Report) |
| PreservePodFraming | True if UDT framing should be preserved for UDTs in the document. This is only valid for an OpenXML output format. (Inherited from net.windward.api.csharp.Report) |
| Properties | As soon as the engine process is created, initialize properties with the engine's properties object. (Inherited from net.windward.api.csharp.Report) |
| RemoveUnusedFormats | True if unused styles, fonts, etc. are not included in the generated report. Default is true. (Inherited from net.windward.api.csharp.Report) |
| RenderExtent | How the generated report will be cropped. This is not supported by all report types. This is presently only supported by ProcessImage and ProcessTxt. Future support will be printer, PostScript, and page-based HTML. (Inherited from net.windward.api.csharp.Report) |
| RenderPages | The pages that will be generated. The string is in the form "0, 4, 6-11, 15" The numbers must be increasing with no overlap. This is not supported by all report types. Set to null for all pages. Pages are 0-based. This is presently only supported by ReportImage. Future support will be printer, PostScript, text, and page-based HTML. (Inherited from net.windward.api.csharp.Report) |
| ReportCharset | Html and txt files are generated using a charset (the rest use unicode). Normally html files are generated using utf-8 (unicode) except for HTML_1 which uses the native charset. Txt files are normally generated using the native charset. The native charset is not the .NET native charset, it is the default charset set in the template document. This call allows you to force to charset the report is written in. The passed in value is the Windows codepage (Western Europe is 1252). This has nothing to do with reading in the template, it only affects the charset the output report is written in. The special enums CHARSET_* allow you to set this to values other than a specific charset. (Inherited from net.windward.api.csharp.Report) |
| ReportType | Get the report format of the output stream. (Inherited from net.windward.api.csharp.Report) |
| Subject | The subject of the document. In html this will set the description meta-tag. (Inherited from net.windward.api.csharp.Report) |
| TagStyle | The style unprocessed tags are written out as. (Inherited from net.windward.api.csharp.Report) |
| TemplateDrillDownInfo | This is not part of the public API. The base directory used for template files in the drill-down tag. (Inherited from net.windward.api.csharp.Report) |
| TemplateVersion | The version of Windward/AutoTag this template was created for. The default is the latest major version number. (Inherited from net.windward.api.csharp.Report) |
| Timeout | Get/set the number of seconds to timeout generating a report. If the report takes longer than this amount of time, it will throw a TimeoutException. A time of 0 means there is no timeout. The default is 0. The count starts when you call processSetup but will only throw the exception in processData and processComplete. (Inherited from net.windward.api.csharp.Report) |
| Title | The title of the document. In html this will set both the TITLE tag and the title meta-tag. (Inherited from net.windward.api.csharp.Report) |
| TrackErrors | Turn on/off the error handling functionality. Call this method on an instance of Report class before calling its Process* methods. The error handling is off by default. Use values of ERROR_HANDLING enumeration. (Inherited from net.windward.api.csharp.Report) |
| TrackImports | True if you want to call getImports after processing datasources. Default is false. (Inherited from net.windward.api.csharp.Report) |
| UseExternalOutputBuilder | Returns true if it will use the external output builder. The external output builder must be loaded and be capable of rendering from the template type to the output type, using all properties set in the ProcessReport object. (Inherited from net.windward.api.csharp.Report) |
Public Constructors
