Click or drag to resize

ReportTemplateGetFile Method

Gives a file name of report template by ID. Saved report template to file.

Namespace:  Velo.Data
Assembly:  Velo.Data (in Velo.Data.dll) Version: 22.2.10.1 (22.2.10.450)
Syntax
public static ReportTemplate GetFile(
	int pID,
	string pConnectionString = ""
)

Parameters

pID
Type: SystemInt32
Template ID
pConnectionString (Optional)
Type: SystemString
Database connection data. Default value see GetConnection(String)

Return Value

Type: ReportTemplate
A report template data item when found or null when not found
Examples
Example use method GetFile(Int32, String) in a web API controller
/// <summary>
/// Gives a file stream as HTTP response message by report template ID
/// </summary>
/// <param name="pID">Report template ID</param>
/// <returns>Report template as file stream</returns>
[HttpGet]
[ActionName("GetFile")]
public HttpResponseMessage GetFile(int pID)
{
    Velo.Data.Models.ReportTemplate lReportTemplate = Velo.Data.ReportTemplate.GetFile(pID: pID);
    var lStream = new FileStream(lReportTemplate.FileName, FileMode.Open);
    var lContent = new HttpResponseMessage(HttpStatusCode.OK)
    {
        Content = new StreamContent(lStream)
    };
    lContent.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
    lContent.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
    {
        FileName = lReportTemplate.Name
    };
    return lContent;
}
Example Javascript call web API controller
function ReportTemplateDownload(pReportTemplateID) {
    // requirement: HTML element ID ReportTemplateDownload
    //              example: <p id="ReportTemplateDownload"></p>

    var lReportTemplateDownload = document.getElementById('ReportTemplateDownload');

    var lURL = getURLRoot() + 'api/ReportTemplateData/GetFile/' + pReportTemplateID;
    lReportTemplateDownload.innerHTML = AlertInformation("<a href=\"" + lURL + "\">Datei öffnen </a>");
}
See also in Javascript file "ReportTemplate.js" region DialogReportTemplateDownloadShow
See Also