MFGS ReportingSSRS Report

MFGSReportingSSRSReport Public interface

Description

Describes methods and properties of a SSRS report.

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph VGWWCoreIEx
  VGWWCoreIEx.IExMFGSReportingSSRSReport[[IExMFGSReportingSSRSReport]]
  class VGWWCoreIEx.IExMFGSReportingSSRSReport interfaceStyle;
  end

Members

Properties

Public properties

Type	Name	Methods
string	Name Gets the name of the report.	get
IExMFGSReportingSSRSParameterCollection	Parameters Gets a collection of parameters for the report.	get
string	ReportPath Gets the path of the report.	get
int	TimeoutSeconds Gets or sets the timeout seconds.	get, set

Methods

Public methods

Returns	Name
IExMFGSEmailMessage	CreateToEmail(object attachmentFormat, bool includeReport, bool includeLink) Renders the report and incorporates it into an email message.
string	SaveToFile(object fileFormat, string fileName) Renders the report and saves it to a file..
void	SendToPrinter(string printer, short copies) Renders the report and sends it to a printer.

Details

Summary

Describes methods and properties of a SSRS report.

Methods

SaveToFile

public string SaveToFile(object fileFormat, string fileName)

Arguments

Type	Name	Description
object	fileFormat	The format the report will be rendered as.
string	fileName	The path and name of the file the report will be save to.

Summary

Renders the report and saves it to a file..

Remarks

fileFormat can be a value of the MFGSSSRSReportFormat enumeration, or the string identifier of a rendering extension.

Returns

The path and file name the report was saved to.

SendToPrinter

public void SendToPrinter(string printer, short copies)

Arguments

Type	Name	Description
string	printer	The name of the printer as defined in Windows.
short	copies	The number of copies to print.

Summary

Renders the report and sends it to a printer.

CreateToEmail

public IExMFGSEmailMessage CreateToEmail(object attachmentFormat, bool includeReport, bool includeLink)

Arguments

Type	Name	Description
object	attachmentFormat	The format the attachment will be rendered as.
bool	includeReport	Determines if the report should be embedded in the email.
bool	includeLink	Determines if a URL link to the report should be included.

Summary

Renders the report and incorporates it into an email message.

Remarks

attachmentFormat can be a value of the MFGSSSRSReportFormat enumeration, or the string identifier of a rendering extension. Using mfgsFormatNONE will result in no attachment.

Returns

An IExMFGSEmailMessage object containing the report.

Properties

Name

public string Name { get; }

Summary

Gets the name of the report.

ReportPath

public string ReportPath { get; }

Summary

Gets the path of the report.

TimeoutSeconds

public int TimeoutSeconds { get; set; }

Summary

Gets or sets the timeout seconds.

Parameters

public IExMFGSReportingSSRSParameterCollection Parameters { get; }

Summary

Gets a collection of parameters for the report.

Generated with ModularDoc