Interface IReportConfigurationProvider
Interface which must be implemented for the ReportManager to work with ReportFiles and it's configurations
Namespace: Simplic.Reporting
Assembly: Simplic.Reporting.dll
Syntax
public interface IReportConfigurationProvider
Methods
| Improve this Doc View SourceDeleteReport(Guid)
Delete report by it's unique id
Declaration
void DeleteReport(Guid id)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | Unique id of the report |
GetConfiguration<T>(Guid)
Get configuration by the unique report id
Declaration
T GetConfiguration<T>(Guid id)
where T : IReportConfiguration
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | Unique id of the report |
Returns
Type | Description |
---|---|
T | If found, instance of the specific report configuration |
Type Parameters
Name | Description |
---|---|
T | IReportConfiguration interface |
GetReportFile(String)
Get the report binary by it's unique report name
Declaration
byte[] GetReportFile(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Unique name of the report |
Returns
Type | Description |
---|---|
System.Byte[] | Report binaries (e.g. content of trdx) |
GetReportId(String)
Get the id of a report by the unique report name
Declaration
Guid GetReportId(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Unique string(name) of the report |
Returns
Type | Description |
---|---|
System.Guid | Id of the report, if not found: Empty guid |
GetReportName(Guid)
Get the name of a report by the unique report id
Declaration
string GetReportName(Guid id)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | Unique Guid(id) of the report |
Returns
Type | Description |
---|---|
System.String | Name of the report, if not found: null |
GetReportType(Guid)
Get the type of a report
Declaration
ReportType GetReportType(Guid id)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | Unique id of the report |
Returns
Type | Description |
---|---|
ReportType | Type of the report (Sql, KeyValue, ...) |
ResolveConnectionString(String)
Resolve a conenction string
Declaration
string ResolveConnectionString(string nameString)
Parameters
Type | Name | Description |
---|---|---|
System.String | nameString | Name or connection string |
Returns
Type | Description |
---|---|
System.String | Valid and complete connection string |
SaveConfiguration<T>(T)
Save report configuration changes
Declaration
void SaveConfiguration<T>(T configuration)
where T : IReportConfiguration
Parameters
Type | Name | Description |
---|---|---|
T | configuration | Instance of the configuration model |
Type Parameters
Name | Description |
---|---|
T | IReportConfiguration interface |
SaveReportFile(String, Byte[])
Save the report binary by it's unique report name
Declaration
void SaveReportFile(string name, byte[] report)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Unique name of the report |
System.Byte[] | report | Report binaries (e.g. content of trdx) |