IDesignerUtilsService.cs 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. using System;
  2. using System.Collections.Generic;
  3. using System.IO;
  4. using System.Text;
  5. namespace FastReport.Web.Services
  6. {
  7. /// <summary>
  8. /// The interface that provides utilities for the Online Designer. Allows to get MsChart Template, component properties and report functions
  9. /// </summary>
  10. /// <remarks>
  11. /// The interface may change over time
  12. /// </remarks>
  13. public interface IDesignerUtilsService
  14. {
  15. /// <summary>
  16. /// Searches for a template by name and returns an XML string with that template
  17. /// </summary>
  18. /// <param name="templateName">Name of the template. Like Blue, Black, etc.</param>
  19. /// <returns>Returns the XML string with the MsChart template. If the template is not found, it returns null</returns>
  20. string GetMSChartTemplateXML(string templateName);
  21. /// <summary>
  22. /// Returns JSON string of connection string properties.
  23. /// </summary>
  24. /// <param name="componentName">The FastReport component whose properties you want to get. Like TextObject, PictureObject etc.</param>
  25. /// <returns>Returns JSON string with FastReport component properties. If the component is not found - returns null</returns>
  26. string GetPropertiesJSON(string componentName);
  27. /// <summary>
  28. /// Retrieves the report functions and returns them to string
  29. /// </summary>
  30. /// <param name="report">Report, the functions of which are to be obtained</param>
  31. /// <returns>Returns a string with the report functions</returns>
  32. string GetFunctions(Report report);
  33. /// <summary>
  34. /// Returns the Online Designer configuration
  35. /// </summary>
  36. /// <param name="webReport">WebReport configuration of which is to be returned</param>
  37. /// <returns>String in JSON format with configuration for Online Designer</returns>
  38. string GetConfig(WebReport webReport);
  39. string DesignerObjectPreview(WebReport webReport, string reportObj);
  40. }
  41. }