Reporting::ReportGenerator Class
Description
Report text generator (used to generate HTML, plaintext ang RTF)
Properties
- persistedCharacter
Type "C". internal persisted state - none, connection, instance. This is used for report objects that stay around, which is not typically the case with web applications where the object lives only as long as the web request.
- contentsCharacter
Type "C". Generated contents of report (if generating to string)
- bookmarksCharacter
Type "C". Generated bookmarks for report.
- tocCharacter
Type "C". Generated table of contents for report.
- indexCharacter
Type "C". Generated index for report.
- record_countNumeric
Numeric record_count property
- ReportObjectResources
Type "ReportObjectResources". Generated bitmaps etc for HTML reports.
- VisualStyleSheetType "C". Stylesheet for report
String VisualStyleSheet property
- Arguments
Type "SQL::Arguments". SQL arguments to pass to report.
- cachePrefixCharacter
Type "C". Internal unique cache id - used to manage cached lookups - useful when optimizing paginated reports.
Methods
- ApplyFilter Method
Apply a filter (modify definition to include added filter).
- ApplyOrder Method
Apply an order (modify definition to include added order at detail level).
- Close Method
Force close for persisted reports.
- ContinueFromPrevious Method
Internal context for a header - continued from pervious page.
- ContinueOnNext Method
Internal context for a footer - continued on next page.
- DefinitionFromLayout Method
Return report definition for the named layout.
- DefinitionFromReportDef Method
Given a report definition (instance), create an HTML definition.
- EmitParameters Method
For the current context, emit the parameters required to re-construct the report.
- EmitResource Method
Adds a named resource object, and return the name that was passed in.
- Generate Method
Generate report as text, using a report definition.
- GenerateFromOpenTable Method
Generate a report from an already open table.
- GenerateToFile Method
Generate report as file, using a report definition (employs streaming, this can be used for *very* big reports.
- GenerateToMemory Method
Generate report as new in-memory table, use first grouping as record - keycolumns specifies column/expression pair, returns name of table.
- GenerateToTable Method
Generate report as new table, use first grouping as record - keycolumns specifies column/expression pair, returns name of table.
- Get Method
Get a report object pointer using a name.
- GetArguments Method
Returns a list of arguments the report expects.
- GetCurrentFilter Method
Get Current Filter.
- GetImports Method
Return a list of arguments the report and children of the report use.
- GetName Method
Return a name that can be used to retrieve the report later.
- Load Method
Create a new report generator.
- SaveResources Method
Save resources as files to path.
- SetBookmarkTemplate Method
Sets the bookmark template.
- SetIndexTemplate Method
Sets the index template.
- SetParentSession Method
Sets the parent session so that global context can be shared with generated reports.
- SetTocTemplate Method
Sets the toc template.
- SubreportCollapse Method
Generate an expanded subreport inside a current report context.
- SubreportExpand Method
Generate an expanded subreport inside a current report context.
- SubreportGenerate Method
Generate a subreport inside a current report context.
- UseMemoryOptimization Method
Set memory override.
See Also