The ReportManager object allows you to register objects that the user can select to generate custom reports in the Report view. To get a reference to the ReportManager object, call Application.GetObject("ReportManager").
None.
Register(name, handler)
name: String
handler: ReportHandler object
Description: This method registers a report with a given name using a given report handler object. The report handler object must be an instance of a class with the GenerateReport method as described below. Multiple reports can be registered for the same report handler object using different report names.
UpdateCurrentReport()
Description: Force a refresh of the current report. If the current report has a script handler, Personal Stock Streamer will call the GenerateReport() method with the appropriate parameters.
GenerateReport(name, app, folder)
name: String
app: AppHandler object
folder: Folder object
Description: When the user wants to generate your custom report, this method is called with the report name. The Folder object is the current portfolio over which the report should be generated. The AppHandler object is used to filter the transactions and actually write the report.
IsReportConfigurable(name)
name: String
returns: Boolean
Description: This is an optional method that can be defined if you want to make your report configurable. (Requires PSS 7.1)
ConfigureReport(name)
name: String
Description: This is an optional method that is called when the user elects to configure the report. This method may display a dialog or window and set the report parameters appropriately. If the configuration is done asynchronously with this method call, then UpdateCurrentReport() should be called to refresh the report view. (Requires PSS 7.1)
FilterPeriod
Type: String
Description: The string description of the currently selected filter period.
FilterDateStart
Type: Date
Description: The start date of the current filter.
FilterDateEnd
Type: Date
Description: The end date of the current filter.
IsTransactionInReport(transaction)
transaction: Transaction object
Returns: Boolean
Description: The GenerateReport method should call this method to determine whether a given transaction falls within the filter defined by the user. It returns True if this is the case.
WriteReport(data)
data: formatted HTML text
Description: The GenerateReport method should call this method to output the formatted HTML report to the Report view. Most HTML 3.2 tags are allowed, and WriteReport can be called as many times as necessary to build up the final HTML report page.