Methods

ClearParameters

Clears the internal report parameter buffer.public void
ClearParameters ();

AddParameter

Adds a report parameter and value to the internal buffer. If the parameter name already exists in the buffer, the value will be changed to represent the most recent addition.
public void AddParameter(string parameterName, string parameterValue);

• parameterName
  Name of the parameter as defined by the report
• parameterValue
  Value for the parameter that is passed to the report.

ParseToAddRestriction

Adds a restriction to the report in the form of an SSRS Report parameter(s).
public void ParseToAddRestriction (string reportRestriction);

• reportRestriction
  SSRS Report parameter(s).

Selection Formula example:
{Service_ID} = 'ABC123' And {Invoice_Num} = 123

SSRS Report parameter example:
&Service_ID=ABC123&Invoice_Num=123

HasReplacement

Checks the WSRepts database table for a replacement report.
public bool HasReplacement(string reportName, string systemDsn, string databaseName);

• reportName
  Name of the report that may have a replacement.
• systemDsn
  System DataSource Name used to access the database.
• databaseName
  Name of the Database to access on the database server.

SetPreviewOptions

Set which options are available to the user on the Preview window.
public void SetPreviewOptions(bool allowExport, bool allowPrint, bool allowRefresh, bool allowSearch, bool allowZoom);

• allowExport
  Allow the user to export the report to various formats.
• allowPrint
  Allow the user to print the report.
• allowRefresh
  Allow the user to refresh the report, which includes the ability to change the parameters to the report.
• allowSearch
  Allow the user to search for text inside the report.
• allowZoom
  Allow the user to make the report larger for easier reading.

PreviewReplacementUsingLocationAndConnection

Previews the passed replacement report reference, using the specified report location and database connection. Returns whether the replacement report was previewed.
public bool PreviewReplacementUsingLocationAndConnection(string reportRef, string reportLocation, IDbConnection dbConn);
public bool PrintReplacementUsingLocationAndConnection(string reportRef, string reportLocation, IDbConnection dbConn);

• reportRef
  Report reference to lookup in the WSRepts table.
• reportLocation
  The location or path to the report file that will be used instead of the location that resides with the report file in the database column ReportLocation.
• dbConn
  The database connection object used to access the database server.

PreviewReplacementUsingLocation

Previews the passed replacement report reference, using the specified report location, accessing the passed System DSN and database name. Returns whether the replacement report was previewed.
public bool PreviewReplacementUsingLocation(string reportRef, string reportLocation, string systemDsn, string databaseName);
public bool PrintReplacementUsingLocation(string reportRef, string reportLocation, string systemDsn, string databaseName);

• reportRef
  Report reference to lookup in the WSRepts table.
• reportLocation
  The location or path to the report file that will be used instead of the location that resides with the report file in the database column ReportLocation.
• systemDsn
  System DataSource Name used to access the database.
• databaseName
  Name of the Database to access on the database server.

PreviewReplacementUsingConnection

Previews the passed replacement report reference, using the specified database connection. Returns whether the replacement report was previewed.
public bool PreviewReplacementUsingConnection(string reportRef, IDbConnection dbConn);
public bool PrintReplacementUsingConnection(string reportRef, IDbConnection dbConn);

• reportRef
  Report reference to lookup in the WSRepts table.
• dbConn
  The database connection object used to access the database server.

PreviewReplacement

Previews the passed replacement report reference, using the passed System DSN and database name. Returns whether the replacement report was previewed.
public bool PreviewReplacement(string reportRef, string systemDsn, string databaseName);
public bool PrintReplacement(string reportRef, string systemDsn, string databaseName);

• reportRef
  Report reference to lookup in the WSRepts table.
• systemDsn
  System DataSource Name used to access the database.
• databaseName
  Name of the database to access on the database server.

PreviewUsingDsn

Previews the passed report name (including full path) using the passed System DSN and database name.
public void PreviewUsingDsn(string reportPath, string systemDsn, string databaseName);
public void PrintUsingDsn(string reportPath, string systemDsn, string databaseName);

• reportPath
  Name of the report to preview, including the full path and filename.
• systemDsn
  System DataSource Name used to access the database.
• databaseName
  Name of the Database to access on the database server.

PreviewUsingConnection

Previews the passed report name (including full path), using the specified database connection.
public void PreviewUsingConnection(string reportPath, IDbConnection dbConn);
public void PrintUsingConnection(string reportPath, IDbConnection dbConn);

• reportPath
  Report reference to lookup in the WSRepts table.
• dbConn
  The database connection object used to access the database server.

PreviewRemote

Previews the passed remote report specified as a URL.
public void PreviewRemote(string reportPath);
public void PrintRemote(string reportPath);

• reportPath
  URL of the SRS Report.

Preview

Previews the report as specified in the XML formatted data string.
public void Preview(string xmlData);
public void Print(string xmlData);

• xmlData
  XML Data that represents the information required to run the report.

See XML Structure section for details.