Export and download Excel spreadsheets using Aspose.Cells in Asp.net WebApi

Question

Export and download Excel spreadsheets using Aspose.Cells in Asp.net WebApi

I am currently using Aspose.Cells to generate an Excel file.

However, I am facing some difficulties in saving the xls file on the disk. Below is a snippet of my get method:

[Route("xls")]
    [HttpGet]
    public HttpResponseMessage Export()
    {
        try
        {
            string dataDir = KnownFolders.GetPath(KnownFolder.Downloads);
            //var workbook = TransferService.Export();  //TODO get xml
            Workbook workbook = new Workbook();              
            var stream = workbook.SaveToStream();   

            // I need save this workbook

            return Request.CreateResponse(HttpStatusCode.OK); //it's not important here
        }
        catch (Exception ex)
        {

            return Request.CreateResponse(HttpStatusCode.InternalServerError); //it's not important here
        }
    }

In addition, I have a function that is triggered onClick:

function exportToXls() {
    $.get(exportURI, function (response) {
        return response;
    });
}

My goal is for the user to be able to click on a button and have the file saved to their disk or prompt them with a browser window to choose the location and name. Any suggestions on how to achieve this?

javascript .net excel asp.net-web-api2 aspose-cells

Answer 1

Answer №1

Working with C# to Export Excel Files

    [Route("xls")]
    [HttpPost] // Using Post is recommended for exporting files
    public HttpResponseMessage Export()
    {
        var response = new HttpResponseMessage();

        try
        {
            // Create a workbook object
            var wb = new Workbook();

            /* ** Add content to the workbook / worksheet here ** */

            // Save workbook to a MemoryStream
            var stream = new MemoryStream();
            wb.Save(stream, SaveFormat.Xlsx);
            stream.Position = 0;    // Ensure the position is reset

            // Attach the stream to the response
            response.Content = new StreamContent(stream);

            // Set the necessary headers
            response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue(dispositionType: "attachment"); // or "inline"
            response.Content.Headers.ContentDisposition.FileName = wb.FileName; // Generate file name dynamically if needed
            response.Content.Headers.ContentType = new MediaTypeHeaderValue(mediaType: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            response.Content.Headers.ContentLength = stream.Length;

            // Set the success status code
            response.StatusCode = HttpStatusCode.OK;
        }
        catch(Exception ex)
        {
            response.StatusCode = HttpStatusCode.InternalServerError;
            response.Content = null; // Just in case
            response.ReasonPhrase = ex.Message;
        }

        return response;
    }

If CORS is enabled, ensure that Content-Disposition header is allowed:

    public static void Register(HttpConfiguration config)
    {
        var cors = new EnableCorsAttribute(origins: "*", headers: "*", methods: "*");
        cors.ExposedHeaders.Add(item: "Content-Disposition");
        config.EnableCors(cors);

        /* Additional WebAPI configuration */
    }

For handling the Javascript side -- this answer might provide insights. (Remember to set the method as POST or adjust accordingly to your requirements.)

Answer 2

Working with C# to Export Excel Files

    [Route("xls")]
    [HttpPost] // Using Post is recommended for exporting files
    public HttpResponseMessage Export()
    {
        var response = new HttpResponseMessage();

        try
        {
            // Create a workbook object
            var wb = new Workbook();

            /* ** Add content to the workbook / worksheet here ** */

            // Save workbook to a MemoryStream
            var stream = new MemoryStream();
            wb.Save(stream, SaveFormat.Xlsx);
            stream.Position = 0;    // Ensure the position is reset

            // Attach the stream to the response
            response.Content = new StreamContent(stream);

            // Set the necessary headers
            response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue(dispositionType: "attachment"); // or "inline"
            response.Content.Headers.ContentDisposition.FileName = wb.FileName; // Generate file name dynamically if needed
            response.Content.Headers.ContentType = new MediaTypeHeaderValue(mediaType: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            response.Content.Headers.ContentLength = stream.Length;

            // Set the success status code
            response.StatusCode = HttpStatusCode.OK;
        }
        catch(Exception ex)
        {
            response.StatusCode = HttpStatusCode.InternalServerError;
            response.Content = null; // Just in case
            response.ReasonPhrase = ex.Message;
        }

        return response;
    }

If CORS is enabled, ensure that Content-Disposition header is allowed:

    public static void Register(HttpConfiguration config)
    {
        var cors = new EnableCorsAttribute(origins: "*", headers: "*", methods: "*");
        cors.ExposedHeaders.Add(item: "Content-Disposition");
        config.EnableCors(cors);

        /* Additional WebAPI configuration */
    }

For handling the Javascript side -- this answer might provide insights. (Remember to set the method as POST or adjust accordingly to your requirements.)

Answer 3

Answer №2

If you want to send your XLS or XLSX file to the browser in ASP.NET, you can achieve this with the code snippet below.

Using C#:

// Save file and send to client browser using selected format
if (yourFileFormat == "XLS")
{
    workbook.Save(HttpContext.Current.Response, "output.xls", ContentDisposition.Attachment, new XlsSaveOptions(SaveFormat.Excel97To2003));
}
else
{
    workbook.Save(HttpContext.Current.Response, "output.xlsx", ContentDisposition.Attachment, new OoxmlSaveOptions(SaveFormat.Xlsx));
}

HttpContext.Current.Response.End();

The provided code will send an XLS file to the browser. If you modify the line as shown below

if(yourFileFormat == "XLSX")

it will then send an XLSX file instead.

To see this code in action, please download the ASP.NET Web Application Project from the link below:

Project Link:

http://www.aspose.com/community/forums/293730/postattachment.aspx

Instead of using the Workbook.SaveToStream() method, consider the alternative approach demonstrated in the following code snippet to obtain a memory stream object for different formats such as XLS and XLSX.

// Create workbook object
Workbook wb = new Workbook("source.xlsx");

// Save Workbook to XLS format
MemoryStream ms1 = new MemoryStream();
wb.Save(ms1, SaveFormat.Excel97To2003);

// Check if memory stream contains XLS bytes
byte[] b1 = ms1.ToArray();
File.WriteAllBytes("output.xls", b1);

// Save Workbook to XLSX format
MemoryStream ms2 = new MemoryStream();
wb.Save(ms2, SaveFormat.Xlsx);

// Check if memory stream contains XLSX bytes
byte[] b2 = ms2.ToArray();
File.WriteAllBytes("output.xlsx", b2);

Note: This information is provided by a Developer Evangelist at Aspose.

Answer 4

If you want to send your XLS or XLSX file to the browser in ASP.NET, you can achieve this with the code snippet below.

Using C#:

// Save file and send to client browser using selected format
if (yourFileFormat == "XLS")
{
    workbook.Save(HttpContext.Current.Response, "output.xls", ContentDisposition.Attachment, new XlsSaveOptions(SaveFormat.Excel97To2003));
}
else
{
    workbook.Save(HttpContext.Current.Response, "output.xlsx", ContentDisposition.Attachment, new OoxmlSaveOptions(SaveFormat.Xlsx));
}

HttpContext.Current.Response.End();

The provided code will send an XLS file to the browser. If you modify the line as shown below

if(yourFileFormat == "XLSX")

it will then send an XLSX file instead.

To see this code in action, please download the ASP.NET Web Application Project from the link below:

Project Link:

http://www.aspose.com/community/forums/293730/postattachment.aspx

Instead of using the Workbook.SaveToStream() method, consider the alternative approach demonstrated in the following code snippet to obtain a memory stream object for different formats such as XLS and XLSX.

// Create workbook object
Workbook wb = new Workbook("source.xlsx");

// Save Workbook to XLS format
MemoryStream ms1 = new MemoryStream();
wb.Save(ms1, SaveFormat.Excel97To2003);

// Check if memory stream contains XLS bytes
byte[] b1 = ms1.ToArray();
File.WriteAllBytes("output.xls", b1);

// Save Workbook to XLSX format
MemoryStream ms2 = new MemoryStream();
wb.Save(ms2, SaveFormat.Xlsx);

// Check if memory stream contains XLSX bytes
byte[] b2 = ms2.ToArray();
File.WriteAllBytes("output.xlsx", b2);

Note: This information is provided by a Developer Evangelist at Aspose.

Answer 5

Answer №3

Modified slightly from Andrew's version using the File action result in .NET.

[HttpGet("download")]
    public async Task<IActionResult> DownloadSystem()
    {
        var workbook = new Workbook();
        var fileName = $"Report.xlsx";
        var cd = new System.Net.Mime.ContentDisposition
        {
            FileName = fileName,
            Inline = false, 
        };
        Response.Headers.Add("Content-Disposition", cd.ToString());
        var stream = new MemoryStream();
        workbook.Save(stream, SaveFormat.Xlsx);
        stream.Position = 0;
        return File(stream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", fileName);
    }

Answer 6

Modified slightly from Andrew's version using the File action result in .NET.

[HttpGet("download")]
    public async Task<IActionResult> DownloadSystem()
    {
        var workbook = new Workbook();
        var fileName = $"Report.xlsx";
        var cd = new System.Net.Mime.ContentDisposition
        {
            FileName = fileName,
            Inline = false, 
        };
        Response.Headers.Add("Content-Disposition", cd.ToString());
        var stream = new MemoryStream();
        workbook.Save(stream, SaveFormat.Xlsx);
        stream.Position = 0;
        return File(stream, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", fileName);
    }

Export and download Excel spreadsheets using Aspose.Cells in Asp.net WebApi

Answer №1

Answer №2

Answer №3

Similar questions

The timing of setTimeout within the $.each function does not behave as expected

Support for the .NET framework at the forefront

Error: a is missing in the Google Maps configuration

The AngularJS plugin "chosen" is experiencing issues with the "chosen:updated" feature, despite functioning

Sinon - observing the constructor function

Is there a way to send the element as an argument within the inner function?

Retrieve the unique payment ID generated from the database and present it on the frontend

Error encounter in JSP is nested within another JSP file, both of which utilize jQuery

Error message displayed: "Unexpected token 'H' when attempting to render Markdown

Discovering the correct way of utilizing Vuelidate's minValue and maxValue functionality

Calculating the hour difference between two time stamps (HH:MM:SS a) using moment.js

How to Condense an Element Using Position: Absolute

A guide on how to implement promise return in redux actions for react native applications

Refresh WebPage automatically after a Servlet successfully uploads and processes an image

An Illustration of Basic Nested Controller within Directive Parameters

Vue - Utilizing child slots in the render method

Generating JSON array objects dynamically in JavaScript code

Partially extended texture in Three.js

Investigate duplicate elements within nested arrays using the 3D array concept

Is it possible to create a channel list using the YouTube API if I am not the owner of the channel? I am not getting any errors, but nothing is showing up