Interface IDesignerUtilsService
The interface that provides utilities for the Online Designer. Allows to get MsChart Template, component properties and report functions
Namespace: FastReport.Web.Services
Assembly: FastReport.OpenSource.Web.dll
Syntax
public interface IDesignerUtilsServiceRemarks
The interface may change over time
Methods
DesignerObjectPreview(WebReport, String)
Retrieves a designer object preview.
Declaration
string DesignerObjectPreview(WebReport webReport, string reportObj)Parameters
| Type | Name | Description |
|---|---|---|
| WebReport | webReport | The WebReport object. |
| System.String | reportObj | The report object. |
Returns
| Type | Description |
|---|---|
| System.String | Returns a string representing the designer object preview. |
GetClassDetailsJson(String)
Gets class details in JSON format.
Declaration
string GetClassDetailsJson(string className)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | className | The name of the class. |
Returns
| Type | Description |
|---|---|
| System.String | Returns class details in JSON format. |
GetConfig(WebReport)
Returns the Online Designer configuration
Declaration
string GetConfig(WebReport webReport)Parameters
| Type | Name | Description |
|---|---|---|
| WebReport | webReport | WebReport configuration of which is to be returned |
Returns
| Type | Description |
|---|---|
| System.String | String in JSON format with configuration for Online Designer |
GetFunctions(Report)
Retrieves the report functions and returns them to string
Declaration
string GetFunctions(Report report)Parameters
| Type | Name | Description |
|---|---|---|
| Report | report | Report, the functions of which are to be obtained |
Returns
| Type | Description |
|---|---|
| System.String | Returns a string with the report functions |
GetMSChartTemplateXML(String)
Searches for a template by name and returns an XML string with that template
Declaration
string GetMSChartTemplateXML(string templateName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | templateName | Name of the template. Like Blue, Black, etc. |
Returns
| Type | Description |
|---|---|
| System.String | Returns the XML string with the MsChart template. If the template is not found, it returns null |
GetNamespacesInfoJson(IReadOnlyCollection<String>)
Gets namespaces information in JSON format.
Declaration
string GetNamespacesInfoJson(IReadOnlyCollection<string> namespaces)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IReadOnlyCollection<System.String> | namespaces | The collection of namespaces. |
Returns
| Type | Description |
|---|---|
| System.String | Returns namespaces information in JSON format. |
GetPropertiesJSON(String)
Returns JSON string of connection string properties.
Declaration
string GetPropertiesJSON(string componentName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | componentName | The FastReport component whose properties you want to get. Like TextObject, PictureObject etc. |
Returns
| Type | Description |
|---|---|
| System.String | Returns JSON string with FastReport component properties. If the component is not found - returns null |