You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Document-Processing/Excel/Spreadsheet/React/open-excel-files.md
+16-11Lines changed: 16 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,13 +9,13 @@ documentation: ug
9
9
10
10
# Open Excel Files in Syncfusion React Spreadsheet
11
11
12
-
The React Spreadsheet component follows an open, server‑assisted workflow to import Excel files accurately and efficiently. When a user uploads an Excel file, the component sends it to the server instead of handling the parsing in the browser. This ensures smooth performance even for large or heavily formatted workbooks.
12
+
The React Spreadsheet component uses a server‑assisted workflow to import Excel files accurately and efficiently. When a user uploads an Excel file, the component sends the file to the server for parsing, ensuring smooth performance because the heavy processing workload is handled on the server side.
13
13
14
-
On the server, the [`Syncfusion.EJ2.Spreadsheet library`](https://www.nuget.org/packages/Syncfusion.EJ2.Spreadsheet.AspNet.Core), built on top of [`Syncfusion XlsIO`](https://help.syncfusion.com/document-processing/excel/excel-library/net/overview), reads the Excel file and extracts all relevant details—data, styles, formulas, formatting, and sheet structure. The server then converts this information into a Spreadsheet‑compatible JSON workbook.
14
+
On the server, the [`Syncfusion.EJ2.Spreadsheet library`](https://www.nuget.org/packages/Syncfusion.EJ2.Spreadsheet.AspNet.Core) built on top of [`Syncfusion XlsIO`](https://help.syncfusion.com/document-processing/excel/excel-library/net/overview), reads the Excel file and extracts all relevant details, including data, styles, formulas, formatting, and sheet structure. The server then converts this information into a Spreadsheet‑compatible JSON workbook.
15
15
16
-
Once the processing is complete, the JSON data is returned to the client, where the React Spreadsheet component renders the workbook in the browser. This process preserves the original Excel layout and ensures the imported content appears with full fidelity.
16
+
Once processing is complete, the JSON workbook is returned to the client, where the React Spreadsheet component renders it in the browser. This workflow preserves the original Excel layout and ensures the imported content appears with full fidelity.
17
17
18
-
To enable opening Excel files, set the [`allowOpen`](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#allowopen) property to **true** and specify the service url using th[`openUrl`](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#openurl) property. The control will send the uploaded file to this endpoint, where it is processed and returned as JSON for the Spreadsheet to render.
18
+
To enable opening Excel files, set the [`allowOpen`](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#allowopen) property to **true** and specify the service url using the[`openUrl`](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#openurl) property. The control will send the uploaded file to this endpoint, where it is processed and returned as JSON for the Spreadsheet to render.
19
19
20
20
For a quick walkthrough on how the open functionality works, refer to the following video:
@@ -39,11 +39,16 @@ The following sample shows the `Open` option by using the [`openUrl`](https://ej
39
39
40
40
Please find the below table for the [beforeOpen](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#beforeopen) event arguments.
41
41
42
-
|**Parameter**|**Type**|**Description**|
43
-
| ----- | ----- | ----- |
44
-
| file | FileList or string or File | To get the file stream. `FileList` - contains length and item index. <br/> `File` - specifies the file lastModified and file name. |
45
-
| cancel | boolean | To prevent the open operation. |
46
-
| requestData | object | To provide the Form data. |
|**cancel**|`boolean`| Specifies whether the open action should be canceled. |
47
+
|**file**|`FileList`\|`string`\|`File`| Specifies the file to be opened. |
48
+
|**parseOptions**|[`WorkbookParseOptions`](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/workbookparseoptions)| Specifies the parsing options that control how the Excel file is interpreted during loading. |
49
+
|**password**|`string`| Specifies the password required to open the Excel file, if it is protected. |
50
+
|**requestData**| object | Specifies any additional data sent along with the open request. |
51
+
|**requestType**|`string`| Specifies the type of open request that triggered the **beforeOpen** event. Possible values:<br><br>• **initial** – The default request made when loading a workbook.<br>• **chunk** – A follow‑up request to load a portion of the workbook when chunking is enabled and the server provides a chunk plan.<br>• **thresholdLimitConfirmed** – A request made after the user confirms a threshold warning (such as *maximumDataLimit* or *maximumFileSizeLimit*) and chooses to proceed. |
47
52
48
53
> * Use `Ctrl + O` keyboard shortcut to open Excel documents.
49
54
> * The default value of the [allowOpen](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#allowopen) property is `true`. For demonstration purpose, we have showcased the [allowOpen](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#allowopen) property in previous code snippet.
@@ -108,9 +113,9 @@ The following Excel file formats are supported for opening in the Spreadsheet co
108
113
109
114
### Open Excel files from local system
110
115
111
-
If you explore your machine to select and upload an Excel document using the file uploader, you will receive the uploaded document as a raw file in the [success](https://ej2.syncfusion.com/react/documentation/api/uploader/index-default#success) event of the file uploader. In this `success` event, you should pass the received raw file as an argument to the Spreadsheet's [open](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#open) method to see the appropriate output.
116
+
If you explore your machine to select and upload an Excel document using the file upload component, you will receive the uploaded document as a raw file in the [success](https://ej2.syncfusion.com/react/documentation/api/uploader/index-default#success) event of the file upload component. In this `success` event, you should pass the received raw file as an argument to the Spreadsheet's [open](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#open) method to see the appropriate output.
112
117
113
-
The following code example shows how to import an Excel document using file uploader in spreadsheet.
118
+
The following code example shows how to import an Excel document using file upload component in spreadsheet.
Copy file name to clipboardExpand all lines: Document-Processing/Excel/Spreadsheet/React/save-excel-files.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,11 @@ documentation: ug
9
9
10
10
# Save Excel Files in Syncfusion React Spreadsheet
11
11
12
-
When exporting an Excel file from the React Spreadsheet component, the workflow is handled through a clear server‑side process. First, the Spreadsheet content displayed in the browser is serialized into a structured JSON workbook. This JSON contains all the necessary details—such as data, formatting, formulas, styles, and sheet structure.
12
+
When exporting an Excel file from the React Spreadsheet component, the process is handled through a streamlined server‑side workflow. The Spreadsheet content displayed in the browser is first serialized into a structured JSON workbook. This JSON includes all essential details—such as data, formulas, formatting, styles, and sheet configuration.
13
13
14
-
This JSON workbook is then sent to the server, where the [`Syncfusion.EJ2.Spreadsheet library`](https://www.nuget.org/packages/Syncfusion.EJ2.Spreadsheet.AspNet.Core) uses [`Syncfusion XlsIO`](https://help.syncfusion.com/document-processing/excel/excel-library/net/overview) to convert the JSON data into a fully formatted Excel file. XlsIO rebuilds the workbook with complete fidelity, preserving all the features applied in the Spreadsheet.
14
+
Once generated, this JSON workbook is sent to the server, where the [`Syncfusion.EJ2.Spreadsheet library`](https://www.nuget.org/packages/Syncfusion.EJ2.Spreadsheet.AspNet.Core) uses [`Syncfusion XlsIO`](https://help.syncfusion.com/document-processing/excel/excel-library/net/overview) to convert the JSON data into a fully formatted Excel file. During this process, the JSON workbook is parsed and its contents are mapped to an XlsIO Workbook instance, ensuring that all data, styles, formulas, and other Spreadsheet features are accurately preserved.
15
15
16
-
Since, the server is responsible for generating the final Excel file, the total export time can vary depending on the workbook’s complexity, including the number of sheets, amount of formatting, and usage of advanced features like formulas or conditional formatting. Once the generation is complete, the Excel file is returned to the client for download.
16
+
Since the server is responsible for generating the final Excel file, the total export time can vary depending on the workbook’s complexity. Factors such as the level of formatting, styles and the use of advanced features like formulas or conditional formatting can influence processing time. After the file is successfully generated, it is sent back to the client for download.
17
17
18
18
To enable saving Excel files, set the [`allowSave`](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#allowsave) property to **true** and specify the service URL using the [`saveUrl`](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#saveurl) property. When a save action is triggered, the control sends the spreadsheet model to this endpoint, where it is processed and returned as a downloadable Excel file.
19
19
@@ -62,7 +62,7 @@ Please find the below table for the [`save`](https://ej2.syncfusion.com/document
| options |`Object`| Options for opening the JSON object. |
65
+
| options |[`SaveOptions`](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/saveoptions)| Options for opening the JSON object. |
66
66
| jsonConfig *(optional)*|[`SerializationOptions`](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/serializationOptions)| Specify the serialization options to customize the loading of the JSON data. |
67
67
68
68
The following code example demonstrates how to save an Excel file programmatically in the Spreadsheet.
0 commit comments