)
We use cookies to give you the best experience on our website. If you continue to browse, then you agree to our privacy policy and cookie policy. (Last updated on: June 24, 2019).
Unfortunately, activation email could not send to your email. Please try again.
Essential JS2

Syncfusion jQuery based widgets are no longer in active development. Switch to our pure JavaScript based next generation Essential JS 2 library.

Syncfusion Feedback

How to send additional parameters to export method in Spreadsheet

Platform: jQuery |
Control: ejSpreadSheet |
Published Date: February 15, 2018 |
Last Revised Date: May 22, 2019

Description

This knowledge base explains how to send additional parameters to export method in Spreadsheet.

Solution

It can be achieved by using “customParams” property in “onExport” client-side event.

 

HTML

 

 
<div id="Spreadsheet"></div>
 

 

JS

 

 
$("#Spreadsheet").ejSpreadsheet({
    exportSettings: {
        excelUrl: "Spreadsheet/ExcelExport",
    },
    onExport: "onExport"
});
 

 

Web API

 
[AcceptVerbs("POST")]
public void ExcelExport()
{
    string sheetModel = HttpContext.Current.Request.Params["sheetModel"], sheetData = HttpContext.Current.Request.Params["sheetData"], myData = HttpContext.Current.Request.Params["myData"];
    Spreadsheet.Save(sheetModel, sheetData, "Sample", ExportFormat.XLSX, ExcelVersion.Excel2013);
}
 

 

RAZOR

 

 
@(Html.EJ().Spreadsheet<object>("Spreadsheet")
    .ExportSettings(export =>
    {
        export.ExcelUrl("ExcelExport");
    })
    .ClientSideEvents(
    events => events.OnExport("onExport")
    )
)
 

 

C#

 
[AcceptVerbs(HttpVerbs.Post)]
public void ExcelExport(string sheetModel, string sheetData, string myData)
{
    Spreadsheet.Save(sheetModel, sheetData, "Sample", ExportFormat.XLSX, ExcelVersion.Excel2013);
}
 

 

ASPX

 

 
<ej:spreadsheet id="Spreadsheet" onserverexcelexporting="Spreadsheet_ServerExcelExporting" runat="server">
    <ClientSideEvents OnExport="onExport" />
    <Sheets>
        <ej:Sheet></ej:Sheet>
    </Sheets>
</ej:spreadsheet>
 

 

ASPX.CS

 

 
protected void Spreadsheet_ServerExcelExporting(object sender, Syncfusion.JavaScript.Web.SpreadsheetEventArgs e)
{
    var args = e.Arguments;
    string sheetModel = args["sheetModel"].ToString();
    string sheetData = args["sheetData"].ToString();
    string myData = args["myData"].ToString();
    Spreadsheet.Save(sheetModel, sheetData, "Sample", ExportFormat.XLSX, ExcelVersion.Excel2013);
}
 

 

 

 
function onExport(args) {
 
    //customParams property is used for sending additional parameters to server.
    args.customParams = { myData: "Spreadsheet" };
 
} 
 

 

You can refer the below documentation,

https://help.syncfusion.com/js/spreadsheet/open-and-save

 

spreadsheet parameters sample preview

ADD COMMENT
You must log in to leave a comment

Please sign in to access our KB

This page will automatically be redirected to the sign-in page in 10 seconds.

Up arrow icon

Warning Icon You are using an outdated version of Internet Explorer that may not display all features of this and other websites. Upgrade to Internet Explorer 8 or newer for a better experience.Close Icon

Live Chat Icon For mobile
Live Chat Icon