Catalyst Fire Ignition Documentation
Report
Retrieve a NetFORUM report, as defined in the configuration file, using the passed parameters.
Definition
Namespace: Ignition.Reporting
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
A ReportShim which contains report metadata as well as the actual report
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
[ObsoleteAttribute("Ignition no longer supports pulling report information from app/web.config. Use the version that takes an ID instead.")]
public ReportResult GetReportByName(
string reportName,
Object parameters,
NetForumReportFormat format = NetForumReportFormat.Pdf
)VB
<ObsoleteAttribute("Ignition no longer supports pulling report information from app/web.config. Use the version that takes an ID instead.")>
Public Function GetReportByName (
reportName As String,
parameters As Object,
Optional format As NetForumReportFormat = NetForumReportFormat.Pdf
) As ReportResultC++
public:
[ObsoleteAttribute(L"Ignition no longer supports pulling report information from app/web.config. Use the version that takes an ID instead.")]
virtual ReportResult^ GetReportByName(
String^ reportName,
Object^ parameters,
NetForumReportFormat format = NetForumReportFormat::Pdf
) sealedF#
[<ObsoleteAttribute("Ignition no longer supports pulling report information from app/web.config. Use the version that takes an ID instead.")>]
abstract GetReportByName :
reportName : string *
parameters : Object *
?format : NetForumReportFormat
(* Defaults:
let _format = defaultArg format NetForumReportFormat.Pdf
*)
-> ReportResult
[<ObsoleteAttribute("Ignition no longer supports pulling report information from app/web.config. Use the version that takes an ID instead.")>]
override GetReportByName :
reportName : string *
parameters : Object *
?format : NetForumReportFormat
(* Defaults:
let _format = defaultArg format NetForumReportFormat.Pdf
*)
-> ReportResult Parameters
- reportName String
- The name of the report as defined in the configuration as "Reports.[reportName]"
- parameters Object
- Anonymous object containing the parameters to pass to the report
- format NetForumReportFormat (Optional)
- File format to use for the returned report
Return Value
ReportResultA ReportShim which contains report metadata as well as the actual report