Class ReportDesignerControllerBase

Base API controller for exposing the Telerik Report Designer Service in an ASP.NET Core application.

Inheritance

System.Object

ReportsControllerBase

ReportDesignerControllerBase

Inherited Members

ReportsControllerBase.GetDocumentFormats()

ReportsControllerBase.RegisterClient()

ReportsControllerBase.UnregisterClient(String)

ReportsControllerBase.KeepClientAlive(String)

ReportsControllerBase.GetClientsSessionTimeoutSeconds()

ReportsControllerBase.GetParameters(String, ClientReportSource)

ReportsControllerBase.CreateInstance(String, ClientReportSource)

ReportsControllerBase.DeleteInstance(String, String)

ReportsControllerBase.CreateDocument(String, String, CreateDocumentArgs)

ReportsControllerBase.DeleteDocument(String, String, String)

ReportsControllerBase.GetDocumentInfo(String, String, String)

ReportsControllerBase.GetDocument(String, String, String)

ReportsControllerBase.SendDocument(String, String, String, SendDocumentArgs)

ReportsControllerBase.GetResource(String, String)

ReportsControllerBase.GetPage(String, String, String, Int32)

ReportsControllerBase.GetResource(String, String, String, String)

ReportsControllerBase.ExecuteInteractiveAction(String, String, String, String)

ReportsControllerBase.GetPageSettings(String, ClientReportSource)

ReportsControllerBase.GetSearchResults(String, String, String, SearchArgs)

ReportsControllerBase.GetVersion()

ReportsControllerBase.CreateMailMessage(SendDocumentArgs, DocumentData)

ReportsControllerBase.SendMailMessage(MailMessage)

ReportsControllerBase.OnCreateDocument(CreateDocumentEventArgs)

ReportsControllerBase.OnGetDocument(GetDocumentEventArgs)

ReportsControllerBase.GetReportInstanceKey(String)

ReportsControllerBase.CreateReportResolver()

ReportsControllerBase.CreateCache()

ReportsControllerBase.CreateStorage()

ReportsControllerBase.GetUserIdentity()

ReportsControllerBase.CreateErrorResponse(HttpStatusCode, String)

ReportsControllerBase.ReportServiceConfiguration

Namespace: Telerik.WebReportDesigner.Services.Controllers

Assembly: Telerik.WebReportDesigner.Services.dll

Syntax

[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
public class ReportDesignerControllerBase : ReportsControllerBase

Constructors

ReportDesignerControllerBase()

Declaration

public ReportDesignerControllerBase()

Properties

ReportDesignerServiceConfiguration

Gets or sets the configuration of the web report designer service.

Declaration

public IReportDesignerServiceConfiguration ReportDesignerServiceConfiguration { get; set; }

Property Value

IReportDesignerServiceConfiguration

Remarks

When inheriting the ReportDesignerControllerBase controller basic configuration is needed. Provide an object implementing the IReportDesignerServiceConfiguration in order to configure the service. This should be done in the controllers' constructor using static object to preserve the configuration between requests or using dependency injection.

See Also

IReportDesignerServiceConfiguration

ReportDesignerServiceConfiguration

Methods

AddConnection(ConnectionInfo)

Add the connection to the connection storage.

Declaration

public IHttpActionResult AddConnection(ConnectionInfo connectionInfo)

Parameters

ConnectionInfo connectionInfo Connection model

Returns

System.Web.Http.IHttpActionResult An empty result or errors, if any have occurred

CanConnect(ConnectionInfo)

Retrieves the connection availability for a specified connection string.

Declaration

public IHttpActionResult CanConnect(ConnectionInfo connectionInfo)

Parameters

ConnectionInfo connectionInfo Connection model

Returns

System.Web.Http.IHttpActionResult Boolean result.

CreateFolder(CreateFolderModel)

Creates the given resource folder

Declaration

public virtual IHttpActionResult CreateFolder(CreateFolderModel model)

Parameters

CreateFolderModel model The CreateFolderModel with the required data

Returns

System.Web.Http.IHttpActionResult ResourceFolderModel

CreateJsonResponse(Object)

Creates a JSON response from an object.

Declaration

protected IHttpActionResult CreateJsonResponse(object value)

Parameters

System.Object value The object instance.

Returns

System.Web.Http.IHttpActionResult A System.Web.Http.IHttpActionResult containing the Json-serialized response.

CreateJsonResponse(String)

Creates a JSON response from a string value.

Declaration

protected IHttpActionResult CreateJsonResponse(string value)

Parameters

System.String value The string value.

Returns

System.Web.Http.IHttpActionResult A System.Web.Http.IHttpActionResult containing the Json-serialized response.

CreateNotFoundResultWithText(String)

Creates a JSON response for a NotFound result.

Declaration

protected IHttpActionResult CreateNotFoundResultWithText(string message)

Parameters

System.String message

Returns

System.Web.Http.IHttpActionResult

CreateReportsFolder(CreateFolderModel)

Creates the given folder (Name) in ParentUri

Declaration

public virtual Task<IHttpActionResult> CreateReportsFolder(CreateFolderModel model)

Parameters

CreateFolderModel model The model containing the create operation data

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult> The ResourceFolderModel of the newly created folder

CreateResourceResolver()

Creates a ResourceResolver instance using the storage from the current configuration.

Declaration

protected virtual IResourceResolver CreateResourceResolver()

Returns

IResourceResolver

CultureContext()

Returns a set with culture-based properties used in serialization.

Declaration

public virtual IHttpActionResult CultureContext()

Returns

System.Web.Http.IHttpActionResult

DeleteFolder(String)

Deletes the given resource folder

Declaration

public virtual IHttpActionResult DeleteFolder(string uri)

Parameters

System.String uri The unique resource identifier (URI)

Returns

System.Web.Http.IHttpActionResult

DeleteReport(String)

Deletes a report from the root folder.

Declaration

[Obsolete("The virtual method Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.DeleteReport is now obsolete. Please use the Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.DeleteReportAsync method.", true)]
public virtual IHttpActionResult DeleteReport(string reportId)

Parameters

System.String reportId The report identifier.

Returns

System.Web.Http.IHttpActionResult

DeleteReportAsync(String)

Deletes a report from the provided URI.

Declaration

public virtual Task<IHttpActionResult> DeleteReportAsync(string uri)

Parameters

System.String uri The report identifier.

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult>

DeleteResource(String)

Deletes an existing resource

Declaration

public virtual IHttpActionResult DeleteResource(string uri)

Parameters

System.String uri The unique resource identifier (URI)

Returns

System.Web.Http.IHttpActionResult

DownloadReport(String)

Returns the report from the root folder as a file.

Declaration

[Obsolete("The virtual method Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.DownloadReport is now obsolete. Please use the Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.DownloadReportAsync method.", true)]
public virtual IHttpActionResult DownloadReport(string uri)

Parameters

System.String uri The report identifier for which report to download.

Returns

System.Web.Http.IHttpActionResult The report as a .trdp or .trdx file.

DownloadReportAsync(String)

Returns the report as a file.

Declaration

public virtual Task<IHttpActionResult> DownloadReportAsync(string uri)

Parameters

System.String uri The report identifier for which report to download.

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult> The report as a .trdp or .trdx file.

ExpressionBuilderParametersHierarchy(Object)

Returns a collection of all parameters.

Declaration

public IHttpActionResult ExpressionBuilderParametersHierarchy(object rawParameters)

Parameters

System.Object rawParameters

Returns

System.Web.Http.IHttpActionResult A System.Web.Http.IHttpActionResult containing the parameters collection.

File(Byte[], String, String)

Returns a File action result with the provided contents.

Declaration

protected IHttpActionResult File(byte[] content, string contentType, string fileName)

Parameters

System.Byte[] content

System.String contentType

System.String fileName

Returns

System.Web.Http.IHttpActionResult

FolderExists(String)

Determines if a folder exists by using its URI.

Declaration

public virtual IHttpActionResult FolderExists(string uri)

Parameters

System.String uri The unique resource identifier (URI) of the folder.

Returns

System.Web.Http.IHttpActionResult FolderHasContentsResponseModel

FolderHasContents(String)

Determines if a folder has contents

Declaration

public virtual IHttpActionResult FolderHasContents(string uri)

Parameters

System.String uri The unique resource identifier (URI)

Returns

System.Web.Http.IHttpActionResult FolderHasContentsResponseModel

FolderNameExists(String)

Determines if a folder exists by using its path with Name identifiers.

Declaration

public virtual IHttpActionResult FolderNameExists(string name)

Parameters

System.String name The full path to the folders with Name identifiers.

Returns

System.Web.Http.IHttpActionResult FolderHasContentsResponseModel

Get(String)

Get the content of a resource file.

Declaration

[Obsolete("Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.Get(string) is obsolete. Please use Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.GetRawResource(GetRawResourceModel)", false)]
public virtual IHttpActionResult Get(string resourceName)

Parameters

System.String resourceName The resource file name.

Returns

System.Web.Http.IHttpActionResult

GetAllByExtension(String)

List all available resource files that match the specified search extension in the resource storage.

Declaration

public virtual IHttpActionResult GetAllByExtension(string extension)

Parameters

System.String extension The resources' extension.

Returns

System.Web.Http.IHttpActionResult An array of ResourceFileModel

GetConnectionsPermissions()

Gets the connections permissions.

Declaration

public IHttpActionResult GetConnectionsPermissions()

Returns

System.Web.Http.IHttpActionResult ConnectionsPermissions.

GetDataConnectionProviders()

Gets a collection of all DB providers.

Declaration

public IHttpActionResult GetDataConnectionProviders()

Returns

System.Web.Http.IHttpActionResult DbProviderInfo array.

GetDataConnections()

Gets a collection of all data connections.

Declaration

public IHttpActionResult GetDataConnections()

Returns

System.Web.Http.IHttpActionResult ConnectionInfo array.

GetDataModel(ObjectDataSourceInfo)

Returns the data fields schema for the specified object data source.

Declaration

public virtual IHttpActionResult GetDataModel(ObjectDataSourceInfo input)

Parameters

ObjectDataSourceInfo input

Returns

System.Web.Http.IHttpActionResult

GetDefaultComponent(String)

Gets the component's default property store.

Declaration

public virtual IHttpActionResult GetDefaultComponent(string typeName)

Parameters

System.String typeName The name of the component type.

Returns

System.Web.Http.IHttpActionResult

GetDesignerResource(String, String)

Gets an embedded report viewer resource.

Declaration

public virtual IHttpActionResult GetDesignerResource(string folder, string resourceName)

Parameters

System.String folder The folder in which the resource is.

System.String resourceName The name of the resource.

Returns

System.Web.Http.IHttpActionResult A System.Web.Http.IHttpActionResult containing the requested resource.

GetExpressionBuilderHierarchy()

Returns a collection of all static expression builder nodes.

Declaration

public IHttpActionResult GetExpressionBuilderHierarchy()

Returns

System.Web.Http.IHttpActionResult A System.Web.Http.IHttpActionResult containing the hierarchy.

GetFolderContents(String)

A list of all available resource files and folders including their details

Declaration

public virtual IHttpActionResult GetFolderContents(string uri)

Parameters

System.String uri The unique resource identifier (URI)

Returns

System.Web.Http.IHttpActionResult FolderContentsResponseModel

GetFolderModel(String)

Gets the folder model on a given URI.

Declaration

public virtual IHttpActionResult GetFolderModel(string uri)

Parameters

System.String uri The URI of the folder.

Returns

System.Web.Http.IHttpActionResult

GetFolderModelByName(String)

Gets the folder model on a given path using Name identifiers

Declaration

public virtual IHttpActionResult GetFolderModelByName(string name)

Parameters

System.String name The full path to the folders with Name identifiers.

Returns

System.Web.Http.IHttpActionResult

GetMembers(TypeInfoWithFilter)

Returns a list of all data members for the specified type.

Declaration

public virtual IHttpActionResult GetMembers(TypeInfoWithFilter input)

Parameters

TypeInfoWithFilter input

Returns

System.Web.Http.IHttpActionResult

GetProceduresSchema(ConnectionInfo)

Retrieves the procedures for the specified data connection.

Declaration

public IHttpActionResult GetProceduresSchema(ConnectionInfo input)

Parameters

ConnectionInfo input Connection model

Returns

System.Web.Http.IHttpActionResult The procedures for the specified data connection or errors, if any have occurred

GetRawResource(String)

Get the content of a resource file.

Declaration

public virtual IHttpActionResult GetRawResource(string uri)

Parameters

System.String uri The unique resource identifier (URI)

Returns

System.Web.Http.IHttpActionResult

GetRawResourceByName(String)

Get the content of a resource file using path with Name identifiers.

Declaration

public virtual IHttpActionResult GetRawResourceByName(string name)

Parameters

System.String name The full path to the resource with Name identifiers.

Returns

System.Web.Http.IHttpActionResult

GetReport(String)

Gets the report definition from the root folder.

Declaration

[Obsolete("The virtual method Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.GetReport is now obsolete. Please use the Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.GetReportAsync method.", true)]
public virtual IHttpActionResult GetReport(string reportId)

Parameters

System.String reportId The report identifier.

Returns

System.Web.Http.IHttpActionResult

GetReportAsync(String)

Gets the report definition.

Declaration

public virtual Task<IHttpActionResult> GetReportAsync(string uri)

Parameters

System.String uri The report identifier.

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult>

GetReportBytes(String, IReportDocument)

For internal use only

Declaration

protected byte[] GetReportBytes(string definitionId, IReportDocument report)

Parameters

System.String definitionId report definition identifier

IReportDocument report report instance

Returns

System.Byte[] The bytes of the serialized report.

GetReportDocument(String, Byte[])

Gets a the report document object by its id and bytes.

Declaration

protected IReportDocument GetReportDocument(string definitionId, byte[] definition)

Parameters

System.String definitionId The report definition identifier.

System.Byte[] definition The report definition in binary format.

Returns

IReportDocument IReportDocument.

GetReportsFolderModel(String)

Gets the folder model on a given URI.

Declaration

public virtual Task<IHttpActionResult> GetReportsFolderModel(string uri)

Parameters

System.String uri The URI of the folder.

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult> The ResourceFolderModel or null if not found.

GetReportsInFolder(String)

Lists the first-level folders and report definitions at the provided folder URI.

Declaration

public virtual Task<IHttpActionResult> GetReportsInFolder(string uri = null)

Parameters

System.String uri

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult>

GetResourceCore(String, String, Type)

Retrieve resources.

Declaration

protected IHttpActionResult GetResourceCore(string folder, string resourceName, Type type = null)

Parameters

System.String folder The folder in which to search for serialized resource.

System.String resourceName The name of the resource.

System.Type type The type of the resource (optional).

Returns

System.Web.Http.IHttpActionResult A System.Web.Http.IHttpActionResult containing the response.

GetResourceFile(String)

Get the content of a resource file by its URI.

Declaration

public virtual IHttpActionResult GetResourceFile(string uri)

Parameters

System.String uri The URI to the resource.

Returns

System.Web.Http.IHttpActionResult

GetResourceModel(String)

Gets the resource model for the given resource.

Declaration

public virtual IHttpActionResult GetResourceModel(string uri)

Parameters

System.String uri The unique resource identifier (URI)

Returns

System.Web.Http.IHttpActionResult ResourceFileModel

GetResourceModelByName(String)

Gets the resource model for the given resource.

Declaration

public virtual IHttpActionResult GetResourceModelByName(string name)

Parameters

System.String name The unique resource identifier (URI)

Returns

System.Web.Http.IHttpActionResult ResourceFileModel

GetSqlDataModel(DataSourceInfo)

Retrieves the fields data model for the specified data connection.

Declaration

public IHttpActionResult GetSqlDataModel(DataSourceInfo dsi)

Parameters

DataSourceInfo dsi

Returns

System.Web.Http.IHttpActionResult The fields data model for the specified data connection or errors, if any have occurred

GetSqlParameters(QueryInfoWithParameters)

Retrieves a collection of all SQL parameters.

Declaration

public IHttpActionResult GetSqlParameters(QueryInfoWithParameters queryInfo)

Parameters

QueryInfoWithParameters queryInfo

Returns

System.Web.Http.IHttpActionResult A collection of all SQL parameters or errors, if any have occurred

GetSqlPreviewData(PreviewDataInfoWithParameters)

Retrieves a preview of the sql data

Declaration

public IHttpActionResult GetSqlPreviewData(PreviewDataInfoWithParameters commandInfo)

Parameters

PreviewDataInfoWithParameters commandInfo

Returns

System.Web.Http.IHttpActionResult A preview of the sql data or errors, if any have occurred

GetTypeMeasures(TypeInfo)

Returns the data fields schema for the specified type. Used for nested measures.

Declaration

public virtual IHttpActionResult GetTypeMeasures(TypeInfo input)

Parameters

TypeInfo input

Returns

System.Web.Http.IHttpActionResult

GetTypes()

Returns a list of all available types.

Declaration

public virtual IHttpActionResult GetTypes()

Returns

System.Web.Http.IHttpActionResult

GetTypeSchema(String)

Gets the type schema for the requested type.

Declaration

public virtual IHttpActionResult GetTypeSchema(string typeName)

Parameters

System.String typeName The name of the type.

Returns

System.Web.Http.IHttpActionResult

GetTypeSchemas(String[])

Gets a collection of type schemas for the requested types.

Declaration

public virtual IHttpActionResult GetTypeSchemas(string[] typeNames)

Parameters

System.String[] typeNames A JSON array containing the type names.

Returns

System.Web.Http.IHttpActionResult

GetWizardStyleSheets(String)

Returns a list of design-time stylesheets.

Declaration

public virtual IHttpActionResult GetWizardStyleSheets(string typeName)

Parameters

System.String typeName The design-time item type name.

Returns

System.Web.Http.IHttpActionResult A System.Web.Http.IHttpActionResult containing the wizard style sheets.

ListFonts()

Lists all available fonts.

Declaration

public virtual IHttpActionResult ListFonts()

Returns

System.Web.Http.IHttpActionResult

MoveFolder(MoveFolderModel)

Moves the given resource folder

Declaration

public virtual IHttpActionResult MoveFolder(MoveFolderModel model)

Parameters

MoveFolderModel model The MoveFolderModel with the required data

Returns

System.Web.Http.IHttpActionResult ResourceFolderModel

MoveResource(MoveResourceModel)

Moves an existing resource

Declaration

public virtual IHttpActionResult MoveResource(MoveResourceModel model)

Parameters

MoveResourceModel model The MoveResourceModel with the required data

Returns

System.Web.Http.IHttpActionResult

OverwriteResource(OverwriteResourceModel)

Overwrites an existing resource

Declaration

public virtual Task<IHttpActionResult> OverwriteResource(OverwriteResourceModel model)

Parameters

OverwriteResourceModel model The OverwriteResourceModel with the required datan

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult> ResourceFileModel

PaperSizes()

Lists all available paper kinds with their size.

Declaration

public virtual IHttpActionResult PaperSizes()

Returns

System.Web.Http.IHttpActionResult

Preview(DataSourceInfo)

Returns a preview of the object data source data.

Declaration

public virtual IHttpActionResult Preview(DataSourceInfo dataSourceInfo)

Parameters

DataSourceInfo dataSourceInfo The object data source model.

Returns

System.Web.Http.IHttpActionResult

PreviewCsv(DataSourceInfo)

Returns a preview of the contents of a csv file.

Declaration

public virtual IHttpActionResult PreviewCsv(DataSourceInfo dataSourceInfo)

Parameters

DataSourceInfo dataSourceInfo The CSV data source model.

Returns

System.Web.Http.IHttpActionResult

PreviewJson(DataSourceInfo)

Returns a preview of the contents of a json file.

Declaration

public virtual IHttpActionResult PreviewJson(DataSourceInfo dataSourceInfo)

Parameters

DataSourceInfo dataSourceInfo The JSON data source model.

Returns

System.Web.Http.IHttpActionResult

PreviewWebServiceData(DataSourceInfo)

Returns a preview of the web service data source.

Declaration

public virtual IHttpActionResult PreviewWebServiceData(DataSourceInfo dataSourceInfo)

Parameters

DataSourceInfo dataSourceInfo The Web service data source model.

Returns

System.Web.Http.IHttpActionResult

RenameFolder(RenameFolderModel)

Renames the given resource folder

Declaration

public virtual IHttpActionResult RenameFolder(RenameFolderModel model)

Parameters

RenameFolderModel model The RenameFolderModel with the required data

Returns

System.Web.Http.IHttpActionResult ResourceFolderModel

RenameResource(RenameResourceModel)

Renames an existing resource

Declaration

public virtual IHttpActionResult RenameResource(RenameResourceModel model)

Parameters

RenameResourceModel model The RenameResourceModel with the required data

Returns

System.Web.Http.IHttpActionResult ResourceFileModel

RenderBarcode(ReportDesignerControllerBase.RenderRuntimeItemModel)

Renders a barcode item to PNG and returns the rendered image.

Declaration

public virtual IHttpActionResult RenderBarcode(ReportDesignerControllerBase.RenderRuntimeItemModel model)

Parameters

ReportDesignerControllerBase.RenderRuntimeItemModel model

Returns

System.Web.Http.IHttpActionResult PNG bytes.

RenderCheckBox(ReportDesignerControllerBase.RenderRuntimeItemModel)

Renders a CheckBox item and returns the rendered HTML.

Declaration

public virtual IHttpActionResult RenderCheckBox(ReportDesignerControllerBase.RenderRuntimeItemModel model)

Parameters

ReportDesignerControllerBase.RenderRuntimeItemModel model

Returns

System.Web.Http.IHttpActionResult PNG bytes

RenderCrossSectionItem(ReportDesignerControllerBase.RenderRuntimeItemModel)

Renders a RenderCrossSectionItem item to PNG and returns the rendered image.

Declaration

public virtual IHttpActionResult RenderCrossSectionItem(ReportDesignerControllerBase.RenderRuntimeItemModel model)

Parameters

ReportDesignerControllerBase.RenderRuntimeItemModel model

Returns

System.Web.Http.IHttpActionResult PNG bytes

RenderGraph(ReportDesignerControllerBase.RenderRuntimeItemModel)

Renders a graph item to PNG and returns the rendered image.

Declaration

public virtual IHttpActionResult RenderGraph(ReportDesignerControllerBase.RenderRuntimeItemModel model)

Parameters

ReportDesignerControllerBase.RenderRuntimeItemModel model

Returns

System.Web.Http.IHttpActionResult PNG bytes.

RenderHtmlTextBox(ReportDesignerControllerBase.RenderRuntimeItemModel)

Renders a HtmlTextBox item to PNG and returns the rendered image.

Declaration

public virtual IHttpActionResult RenderHtmlTextBox(ReportDesignerControllerBase.RenderRuntimeItemModel model)

Parameters

ReportDesignerControllerBase.RenderRuntimeItemModel model

Returns

System.Web.Http.IHttpActionResult PNG bytes.

RenderMap(ReportDesignerControllerBase.RenderRuntimeItemModel)

Renders a map item to PNG and returns the rendered image.

Declaration

public virtual IHttpActionResult RenderMap(ReportDesignerControllerBase.RenderRuntimeItemModel model)

Parameters

ReportDesignerControllerBase.RenderRuntimeItemModel model

Returns

System.Web.Http.IHttpActionResult PNG bytes.

RenderPictureBox(ReportDesignerControllerBase.RenderRuntimeItemModel)

Renders a PictureBox item to PNG and returns the rendered image.

Declaration

public virtual IHttpActionResult RenderPictureBox(ReportDesignerControllerBase.RenderRuntimeItemModel model)

Parameters

ReportDesignerControllerBase.RenderRuntimeItemModel model

Returns

System.Web.Http.IHttpActionResult PNG bytes

RenderShape(ReportDesignerControllerBase.RenderRuntimeItemModel)

Renders a Shape item to PNG and returns the rendered image.

Declaration

public virtual IHttpActionResult RenderShape(ReportDesignerControllerBase.RenderRuntimeItemModel model)

Parameters

ReportDesignerControllerBase.RenderRuntimeItemModel model

Returns

System.Web.Http.IHttpActionResult PNG bytes

ReportExistsAsync(String)

Determines if a report definition exists by its URI.

Declaration

public virtual Task<IHttpActionResult> ReportExistsAsync(string uri)

Parameters

System.String uri The report URI.

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult>

ResourceNameExists(String)

Determines if a resource with the provided name exists.

Declaration

public virtual IHttpActionResult ResourceNameExists(string name)

Parameters

System.String name The full path to the resource using Name identifiers.

Returns

System.Web.Http.IHttpActionResult true, if the resource exists, else false.

ResourceUriExists(String)

Determines if a resource with the provided URI exists.

Declaration

public virtual IHttpActionResult ResourceUriExists(string uri)

Parameters

System.String uri The URI of the resource.

Returns

System.Web.Http.IHttpActionResult true, if the resource exists, else false.

Save(String)

Creates a new resource.

Declaration

[Obsolete("Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.Save(string) is obsolete. Please use Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.Save(SaveResourceModel)", false)]
public virtual Task<IHttpActionResult> Save(string resourceName)

Parameters

System.String resourceName The resource file name.

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult>

SaveReport(String, Object)

Creates a new report or updates an existing report.

Declaration

[Obsolete("The virtual method Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.SaveReport is now obsolete. Please use the Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.SaveReportAsync method.", true)]
public virtual IHttpActionResult SaveReport(string reportId, object definition)

Parameters

System.String reportId The report identifier.

System.Object definition The report definition in JSON format.

Returns

System.Web.Http.IHttpActionResult

SaveReportByUriAsync(String, Object)

Creates a new report or updates an existing report.

Declaration

public virtual Task<IHttpActionResult> SaveReportByUriAsync(string uri, object definition)

Parameters

System.String uri The report identifier.

System.Object definition The report definition in JSON format.

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult>

SaveResource(SaveResourceModel)

Creates a new resource.

Declaration

public virtual Task<IHttpActionResult> SaveResource(SaveResourceModel model)

Parameters

SaveResourceModel model The SaveResourceModel with the required data

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult> ResourceFileModel

SearchResources(SearchResourcesModel)

Searches for resources and resource folders

Declaration

public virtual IHttpActionResult SearchResources(SearchResourcesModel model)

Parameters

SearchResourcesModel model The SearchResourcesModel with the required data

Returns

System.Web.Http.IHttpActionResult SearchResourceResponseModel

UploadReportAsync(String)

Receive a report in file format and saves it to storage

Declaration

public virtual Task<IHttpActionResult> UploadReportAsync(string uri)

Parameters

System.String uri

Returns

System.Threading.Tasks.Task<System.Web.Http.IHttpActionResult>