Plugin Class

Base implementation of the plugin interface to the Report Miner processing engine.

Remarks

All plugin functions are implemented as virtual methods that return a code to continue with the normal processing. The API clients can override any number of these virtual functions to implement customized handling of the processing workflow.

Inheritance Hierarchy

SystemObject
Opait.ReportMiner.ApiPlugin

Namespace: Opait.ReportMiner.Api
Assembly: Opait.ReportMiner (in Opait.ReportMiner.dll) Version: 1.9.4.12917

Syntax

Copy

public class Plugin : IPlugin

The Plugin type exposes the following members.

Constructors

	Name	Description
	Plugin	Initializes a new instance of the Plugin class

Top

Methods

	Name	Description
	OnGetSourcePassword	Called when a password is needed to open the source file.
	OnGlobalsReady	Called when the export job has finished processing global fields.
	OnJobCompleted	Called when the export job has finished processing.
	OnJobStartup	Called when a new job is about to start.
	OnPageReady	Called when a page is about to be parsed.
	OnRecordReady	Called when a record has been parsed and is ready for save.
	OnSourceReady	Called when the source file for an export job has been initialized.

Top

Reference

Opait.ReportMiner.Api Namespace