Interface IStonefieldQueryReportEnginePlugin

The interface that ReportEngine plugins must implement.


public abstract interface IStonefieldQueryReportEnginePlugin

Interface Members

MemberDescription

AfterCreateLayout

Executes just after the layout for the specified report is created.

public bool AfterCreateLayout(IReport report);

AfterDataRetrieved

Executes just after the data for the specified report is retrieved.

public bool AfterDataRetrieved(IReport report,
    IDataEngine dataEngine);

AfterReportCopied

Executes just after the specified report is copied.

public void AfterReportCopied(IReport report,
    IReport copy);

public void AfterReportCopied(IReportBase report,
    IReportBase copy);

AfterReportDeleted

Executes just after the specified report is deleted.

public void AfterReportDeleted(IReport report,
    bool reportWasDeleted);

public void AfterReportDeleted(IReportBase report,
    bool reportWasDeleted);

AfterReportSaved

Executes just after the specified report is saved.

public void AfterReportSaved(IReport report);

public void AfterReportSaved(IReportBase report);

AfterSQLStatementGenerated

Executes after the SQL statement has been generated and is about to be sent to the database engine.

public string AfterSQLStatementGenerated(IReport report,
    string sqlStatement,
    Object[] parameters,
    string tablename,
    IDbConnection conn,
    IDbCommand cmd);

public string AfterSQLStatementGenerated(IReport report,
    string sqlStatement,
    Object[] parameters,
    string tablename,
    IDbConnection conn,
    IDbCommand cmd,
    string datasourcename);

BeforeCreateLayout

Executes just before the layout for the specified report is created.

public bool BeforeCreateLayout(IReport report);

BeforeDataRetrieved

Executes just before the data for the specified report is retrieved.

public bool BeforeDataRetrieved(IReport report,
    IDataEngine dataEngine);

BeforeExportReport

Executes just before the specified report is exported to a file.

public bool BeforeExportReport(IReport report,
    string fileName);

public bool BeforeExportReport(IReport report,
    Stream stream);

BeforeReportCopied

Executes just before the specified report is copied.

public bool BeforeReportCopied(IReport report,
    string name);

public bool BeforeReportCopied(IReportBase report,
    string name);

BeforeReportDeleted

Executes just before the specified report is deleted.

public bool BeforeReportDeleted(IReport report);

public bool BeforeReportDeleted(IReportBase report);

BeforeReportSaved

Executes just before the specified report is saved.

public void BeforeReportSaved(IReport report);

public void BeforeReportSaved(IReportBase report);

BeforeSQLStatementSentToDatabase

Executes after the connnection to the database has been opened but before the SQL statement is sent to the database. This can be used to configure the connection, such as issuing SET ANSI_PADDING OFF or other types of connection settings.

public void BeforeSQLStatementSentToDatabase(IDbConnection conn);

CanUserAccessReport

Returns true if the user can access the specified report.

public bool CanUserAccessReport(IReport report);

public bool CanUserAccessReport(IReportBase report);

ReportCreated

Executes when a report is created.

public void ReportCreated(IReport report);

public void ReportCreated(IReportBase report);

Requirements

Namespace: Stonefield.Query.Plugins
Assembly: interfaces.dll