From cc222cd68ef709edd87fb770b305c645a8fc2c5f Mon Sep 17 00:00:00 2001 From: VinothSF5015 Date: Tue, 14 Apr 2026 00:31:26 +0530 Subject: [PATCH 001/141] 1007137 - Content Added --- Document-Processing-toc.html | 3 + ...t-invert-if-negative-option-for-a-chart.md | 76 +++++++++++++++++++ 2 files changed, 79 insertions(+) create mode 100644 Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md diff --git a/Document-Processing-toc.html b/Document-Processing-toc.html index e98d61bfb..e2fbe052a 100644 --- a/Document-Processing-toc.html +++ b/Document-Processing-toc.html @@ -6641,6 +6641,9 @@
  • How to retrieve the name of the chart in an Excel worksheet?
  • +
  • + How to set invert if negative option for a chart using XLsIO? +
  • diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md new file mode 100644 index 000000000..e9aeb8853 --- /dev/null +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md @@ -0,0 +1,76 @@ +--- +title: Setting Invert If negative option in Chart properties using Syncfusion XLsIO | Syncfusion +description: This page tells how to set invert if negative option for a chart. +platform: document-processing +control: XlsIO +documentation: UG +--- + +# How to set invert if negative option for a chart using XLsIO? + +This following code samples demonstrate how to set invert if negative option for a chart using C# (Cross-platform and Windows-specific) and VB.NET. + +{% tabs %} +{% highlight c# tabtitle="C# [Cross-platform]" %} +using (ExcelEngine excelEngine = new ExcelEngine()) +{ + #region Workbook Initialization + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + IWorkbook workbook = application.Workbooks.Open(Path.GetFullPath(@"Data/InputTemplate.xlsx")); + IWorksheet worksheet = workbook.Worksheets[0]; + #endregion + + IChart chart = worksheet.Charts[0]; + + //Used to invert series color if the value is negative + (chart.Series[0] as ChartSerieImpl).InvertIfNegative = true; + + #region Save + //Saving the workbook + workbook.SaveAs(Path.GetFullPath("Output/Output.xlsx")); + #endregion +} +{% endhighlight %} + +{% highlight c# tabtitle="C# [Windows-specific]" %} +using (ExcelEngine excelEngine = new ExcelEngine()) +{ + #region Workbook Initialization + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + IWorkbook workbook = application.Workbooks.Open("InputTemplate.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + #endregion + + IChart chart = worksheet.Charts[0]; + + //Used to invert series color if the value is negative + (chart.Series[0] as ChartSerieImpl).InvertIfNegative = true; + + #region Save + //Saving the workbook + workbook.SaveAs("Output.xlsx"); + #endregion +} +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET [Windows-specific]" %} +Using excelEngine As New ExcelEngine() + Dim application As IApplication = excelEngine.Excel + application.DefaultVersion = ExcelVersion.Xlsx + Dim workbook As IWorkbook = application.Workbooks.Open("InputTemplate.xlsx") + Dim worksheet As IWorksheet = workbook.Worksheets(0) + + Dim chart As IChart = worksheet.Charts(0) + + 'Used to invert series color if the value is negative + DirectCast(chart.Series(0), ChartSerieImpl).InvertIfNegative = True + + 'Saving the workbook + workbook.SaveAs("Output.xlsx") +End Using +{% endhighlight %} +{% endtabs %} + +A complete working example in C# is present on this GitHub page. \ No newline at end of file From 5e66075bc2bf509b7ac1662a0c52e7cf900d816e Mon Sep 17 00:00:00 2001 From: VinothSF5015 Date: Tue, 14 Apr 2026 10:32:38 +0530 Subject: [PATCH 002/141] Update how-to-set-invert-if-negative-option-for-a-chart.md --- .../how-to-set-invert-if-negative-option-for-a-chart.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md index e9aeb8853..5d8a2c929 100644 --- a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md @@ -1,6 +1,6 @@ --- -title: Setting Invert If negative option in Chart properties using Syncfusion XLsIO | Syncfusion -description: This page tells how to set invert if negative option for a chart. +title: Setting Invert If negative option in Chart properties | Syncfusion +description: This page tells how to set invert if negative option for a chart using Syncfusion XlsIO in C# (Cross-platform and Windows-specific) and VB.NET. platform: document-processing control: XlsIO documentation: UG @@ -73,4 +73,4 @@ End Using {% endhighlight %} {% endtabs %} -A complete working example in C# is present on this GitHub page. \ No newline at end of file +A complete working example in C# is present on this GitHub page. From 5cf9389da91ad87d0d4a42dab2d17e1822308aef Mon Sep 17 00:00:00 2001 From: VinothSF5015 Date: Tue, 14 Apr 2026 11:17:36 +0530 Subject: [PATCH 003/141] Update how-to-set-invert-if-negative-option-for-a-chart.md --- .../faqs/how-to-set-invert-if-negative-option-for-a-chart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md index 5d8a2c929..c706c3b63 100644 --- a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md @@ -6,7 +6,7 @@ control: XlsIO documentation: UG --- -# How to set invert if negative option for a chart using XLsIO? +# How to set invert if negative option for a chart using XlsIO? This following code samples demonstrate how to set invert if negative option for a chart using C# (Cross-platform and Windows-specific) and VB.NET. From 86937eca9c75a50e4a82e1637846ad92a9d73d40 Mon Sep 17 00:00:00 2001 From: VinothSF5015 Date: Mon, 20 Apr 2026 18:47:14 +0530 Subject: [PATCH 004/141] Content added --- ...t-invert-if-negative-option-for-a-chart.md | 66 ++++++++++++++++++- 1 file changed, 65 insertions(+), 1 deletion(-) diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md index c706c3b63..e4c79e30e 100644 --- a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md @@ -8,7 +8,8 @@ documentation: UG # How to set invert if negative option for a chart using XlsIO? -This following code samples demonstrate how to set invert if negative option for a chart using C# (Cross-platform and Windows-specific) and VB.NET. + +The following code samples demonstrate how to set the "Invert if negative" option for a chart using C# (Cross-platform and Windows-specific) and VB.NET for XLSX files. For XLS (binary) file format, see the section below. {% tabs %} {% highlight c# tabtitle="C# [Cross-platform]" %} @@ -74,3 +75,66 @@ End Using {% endtabs %} A complete working example in C# is present on this GitHub page. + +# How to set invert if negative option for a chart in XLS (binary) file format? + +In case of binary file format (XLS), kindly use the following code snippet. + +{% tabs %} +{% highlight c# tabtitle="C# [Cross-platform]" %} +using (ExcelEngine excelEngine = new ExcelEngine()) +{ + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel97to2003; + IWorkbook workbook = application.Workbooks.Open("InputTemplate.xls"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IChart chart = worksheet.Charts[0]; + + // Used to invert series color if the value is negative in XLS (binary) format + chart.Series[0].SerieFormat.Interior.SwapColorsOnNegative = true; + + // Saving the workbook + workbook.SaveAs("Output.xls"); +} +{% endhighlight %} + +{% highlight c# tabtitle="C# [Windows-specific]" %} +using (ExcelEngine excelEngine = new ExcelEngine()) +{ + #region Workbook Initialization + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + IWorkbook workbook = application.Workbooks.Open("InputTemplatexlsx.xls"); + IWorksheet worksheet = workbook.Worksheets[0]; + #endregion + + IChart chart = worksheet.Charts[0]; + + // Used to invert series color if the value is negative in XLS (binary) format + chart.Series[0].SerieFormat.Interior.SwapColorsOnNegative = true; + + #region Save + //Saving the workbook + workbook.SaveAs("Output.xls"); + #endregion +} +{% endhighlight %} + +{% highlight vb.net tabtitle="VB.NET [Windows-specific]" %} +Using excelEngine As New ExcelEngine() + Dim application As IApplication = excelEngine.Excel + application.DefaultVersion = ExcelVersion.Excel97to2003 + Dim workbook As IWorkbook = application.Workbooks.Open("InputTemplate.xls") + Dim worksheet As IWorksheet = workbook.Worksheets(0) + + Dim chart As IChart = worksheet.Charts(0) + + ' Used to invert series color if the value is negative in XLS (binary) format + chart.Series(0).SerieFormat.Interior.SwapColorsOnNegative = True + + ' Saving the workbook + workbook.SaveAs("Output.xls") +End Using +{% endhighlight %} +{% endtabs %} \ No newline at end of file From a43b2db5aa7d65e119a9c915a148bd2038c2646a Mon Sep 17 00:00:00 2001 From: VinothSF5015 Date: Mon, 20 Apr 2026 18:56:17 +0530 Subject: [PATCH 005/141] Issue Fixed --- .../faqs/how-to-set-invert-if-negative-option-for-a-chart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md index e4c79e30e..fbac3fe1b 100644 --- a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-set-invert-if-negative-option-for-a-chart.md @@ -76,7 +76,7 @@ End Using A complete working example in C# is present on this GitHub page. -# How to set invert if negative option for a chart in XLS (binary) file format? +## How to set invert if negative option for a chart in XLS (binary) file format? In case of binary file format (XLS), kindly use the following code snippet. From a180bbb1a7cadc4428b5e4949b970ee547279859 Mon Sep 17 00:00:00 2001 From: mercy-orejo Date: Thu, 23 Apr 2026 14:36:36 +0300 Subject: [PATCH 006/141] Task-219947-SERPSTAT-Issue-fixes-Help-Domain-doc-processing-Server-Status-Code-Error --- ...w-to-copy-a-range-from-one-workbook-to-another.md | 12 ++++++------ ...h-a-matching-case-for-specific-column-in-Excel.md | 12 ++++++------ .../NET/faqs/how-to-format-text-within-a-cell.md | 12 ++++++------ .../how-to-overcome-unauthorizedaccessexception.md | 8 ++++---- ...he-zip-files-using-syncfusion-compression-base.md | 4 ++-- ...les-in-subfolders-using-syncfusion-compression.md | 8 ++++---- ...use-autodetectcomplexscript-converter-property.md | 12 ++++++------ 7 files changed, 34 insertions(+), 34 deletions(-) diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-copy-a-range-from-one-workbook-to-another.md b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-copy-a-range-from-one-workbook-to-another.md index b5d14f8b1..82bf866d9 100644 --- a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-copy-a-range-from-one-workbook-to-another.md +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-copy-a-range-from-one-workbook-to-another.md @@ -8,7 +8,7 @@ documentation: UG # How to copy a range from one workbook to another? -You can copy the range from source workbook to the destination workbook through [CopyTo](https://help.syncfusion.com/cr/file-formats/Syncfusion.XlsIO.IRange.html#Syncfusion_XlsIO_IRange_CopyTo_Syncfusion_XlsIO_IRange_Syncfusion_XlsIO_ExcelCopyRangeOptions_) method. +You can copy the range from source workbook to the destination workbook through [CopyTo](https://help.syncfusion.com/cr/document-processing/Syncfusion.XlsIO.IRange.html#Syncfusion_XlsIO_IRange_CopyTo_Syncfusion_XlsIO_IRange_Syncfusion_XlsIO_ExcelCopyRangeOptions_) method. The following code snippet illustrates this. @@ -92,8 +92,8 @@ End Using ## See Also -* [How to copy/paste the cell values that contain only formula?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-copy-paste-the-cell-values-that-contain-only-formula) -* [How to copy or move a range?](https://help.syncfusion.com/file-formats/xlsio/worksheet-cells-manipulation#copy-or-move-a-range) -* [How to copy and paste as link?](https://help.syncfusion.com/file-formats/xlsio/worksheet-cells-manipulation#copy-and-paste-as-link) -* [How to skip blanks while copying?](https://help.syncfusion.com/file-formats/xlsio/worksheet-cells-manipulation#skip-blanks-while-copying) -* [How to open an existing XLSX workbook and save it as XLS?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-open-an-existing-xlsx-workbook-and-save-it-as-xls) +* [How to copy/paste the cell values that contain only formula?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-copy-paste-the-cell-values-that-contain-only-formula) +* [How to copy or move a range?](https://help.syncfusion.com/document-processing/excel/excel-library/net/worksheet-cells-manipulation#copy-or-move-a-range) +* [How to copy and paste as link?](https://help.syncfusion.com/document-processing/excel/excel-library/net/worksheet-cells-manipulation#copy-and-paste-as-link) +* [How to skip blanks while copying?](https://help.syncfusion.com/document-processing/excel/excel-library/net/worksheet-cells-manipulation#skip-blanks-while-copying) +* [How to open an existing XLSX workbook and save it as XLS?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-open-an-existing-xlsx-workbook-and-save-it-as-xls) diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-find-values-with-a-matching-case-for-specific-column-in-Excel.md b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-find-values-with-a-matching-case-for-specific-column-in-Excel.md index 30726b4d2..52f11d5b6 100644 --- a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-find-values-with-a-matching-case-for-specific-column-in-Excel.md +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-find-values-with-a-matching-case-for-specific-column-in-Excel.md @@ -7,7 +7,7 @@ documentation: UG --- # How to find values with a matching case for specific column in Excel? -XlsIO allows finding values with matching case for specific column in Excel worksheet using **MatchCase** option of [ExcelFindOptions](https://help.syncfusion.com/cr/file-formats/Syncfusion.XlsIO.ExcelFindOptions.html) enumeration through [Find](https://help.syncfusion.com/cr/file-formats/Syncfusion.XlsIO.Implementation.WorksheetImpl.html#Syncfusion_XlsIO_Implementation_WorksheetImpl_Find_Syncfusion_XlsIO_IRange_System_String_Syncfusion_XlsIO_ExcelFindType_Syncfusion_XlsIO_ExcelFindOptions_System_Boolean_) method of [WorksheetImpl](https://help.syncfusion.com/cr/file-formats/Syncfusion.XlsIO.Implementation.WorksheetImpl.html). The following code illustrates this. +XlsIO allows finding values with matching case for specific column in Excel worksheet using **MatchCase** option of [ExcelFindOptions](https://help.syncfusion.com/cr/document-processing/Syncfusion.XlsIO.ExcelFindOptions.html) enumeration through [Find](https://help.syncfusion.com/cr/document-processing/Syncfusion.XlsIO.Implementation.WorksheetImpl.html#Syncfusion_XlsIO_Implementation_WorksheetImpl_Find_Syncfusion_XlsIO_IRange_System_String_Syncfusion_XlsIO_ExcelFindType_Syncfusion_XlsIO_ExcelFindOptions_System_Boolean_) method of [WorksheetImpl](https://help.syncfusion.com/cr/document-processing/Syncfusion.XlsIO.Implementation.WorksheetImpl.html). The following code illustrates this. {% tabs %} {% highlight c# tabtitle="C# [Cross-platform]" %} @@ -82,11 +82,11 @@ End Using ## See Also -* [How to opening an existing workbook?](https://help.syncfusion.com/file-formats/xlsio/loading-and-saving-workbook#opening-an-existing-workbook) -* [How to perform Find and Replace?](https://help.syncfusion.com/file-formats/xlsio/worksheet-cells-manipulation#find-and-replace) -* [How to get entire column of the particular range?](https://help.syncfusion.com/file-formats/xlsio/worksheet-cells-manipulation#entire-column) -* [How to define discontinuous ranges?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-define-discontinuous-ranges) +* [How to opening an existing workbook?](https://help.syncfusion.com/document-processing/excel/excel-library/net/loading-and-saving-workbook#opening-an-existing-workbook-from-stream) +* [How to perform Find and Replace?](https://help.syncfusion.com/document-processing/excel/excel-library/net/worksheet-cells-manipulation#find-and-replace) +* [How to get entire column of the particular range?](https://help.syncfusion.com/document-processing/excel/excel-library/net/worksheet-cells-manipulation#entire-column) +* [How to define discontinuous ranges?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-define-discontinuous-ranges) * [How to create and open Excel Template files by using XlsIO?](how-to-create-and-open-excel-template-files-by-using-xlsio) * [How to copy a range from one workbook to another?](how-to-copy-a-range-from-one-workbook-to-another) * [How to sort two or more columns in a pivot table?](how-to-sort-two-or-more-columns-in-a-pivot-table) -* [How to move or copy a worksheet?](https://help.syncfusion.com/file-formats/xlsio/working-with-excel-worksheet#move-or-copy-a-worksheet) +* [How to move or copy a worksheet?](https://help.syncfusion.com/document-processing/excel/excel-library/net/worksheet/move-or-copy) diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-format-text-within-a-cell.md b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-format-text-within-a-cell.md index 52b70f3ed..1b8c86388 100644 --- a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-format-text-within-a-cell.md +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-format-text-within-a-cell.md @@ -108,9 +108,9 @@ End Using ## See Also -* [How to set a line break inside a cell?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-set-a-line-break-inside-a-cell) -* [How to protect certain cells in a worksheet?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-protect-certain-cells-in-a-worksheet) -* [How to copy/paste the cell values that contain only formula?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-copy-paste-the-cell-values-that-contain-only-formula) -* [How to rich-text formatting?](https://help.syncfusion.com/file-formats/xlsio/working-with-cell-or-range-formatting#rich-text-formatting) -* [How to apply number formats?](https://help.syncfusion.com/file-formats/xlsio/working-with-cell-or-range-formatting#apply-number-formats) -* [How to apply cell text alignment?](https://help.syncfusion.com/file-formats/xlsio/working-with-cell-or-range-formatting#apply-cell-text-alignment) +* [How to set a line break inside a cell?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-set-a-line-break-inside-a-cell) +* [How to protect certain cells in a worksheet?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-protect-certain-cells-in-a-worksheet) +* [How to copy/paste the cell values that contain only formula?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-copy-paste-the-cell-values-that-contain-only-formula) +* [How to rich-text formatting?](https://help.syncfusion.com/document-processing/excel/excel-library/net/working-with-cell-or-range-formatting#rich-text-formatting) +* [How to apply number formats?](https://help.syncfusion.com/document-processing/excel/excel-library/net/working-with-cell-or-range-formatting#apply-number-formats) +* [How to apply cell text alignment?](https://help.syncfusion.com/document-processing/excel/excel-library/net/working-with-cell-or-range-formatting#apply-cell-text-alignment) diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-overcome-unauthorizedaccessexception.md b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-overcome-unauthorizedaccessexception.md index ca60c99c4..ab40452c8 100644 --- a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-overcome-unauthorizedaccessexception.md +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-overcome-unauthorizedaccessexception.md @@ -14,7 +14,7 @@ First, check whether you can access the folder and the file directly. Then, righ ## See Also -* [How to overcome StackOverflow exception with IWorksheet Calculate()?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-overcome-stackoverflow-exception-with-iworksheet-calculate) -* [How to avoid exception when adding worksheets with same name?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-avoid-exception-when-adding-worksheets-with-same-name) -* [What are the known exceptions of XlsIO?](https://help.syncfusion.com/file-formats/xlsio/known-exceptions) -* [How to secure Excel documents?](https://help.syncfusion.com/file-formats/xlsio/security) +* [How to overcome StackOverflow exception with IWorksheet Calculate()?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-overcome-stackoverflow-exception-with-iworksheet-calculate) +* [How to avoid exception when adding worksheets with same name?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-avoid-exception-when-adding-worksheets-with-same-name) +* [What are the known exceptions of XlsIO?](https://help.syncfusion.com/document-processing/excel/excel-library/net/known-exceptions) +* [How to secure Excel documents?](https://help.syncfusion.com/document-processing/excel/excel-library/net/security) diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-protect-the-zip-files-using-syncfusion-compression-base.md b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-protect-the-zip-files-using-syncfusion-compression-base.md index 08121b0f9..cfb8257de 100644 --- a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-protect-the-zip-files-using-syncfusion-compression-base.md +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-protect-the-zip-files-using-syncfusion-compression-base.md @@ -68,5 +68,5 @@ End Module * [How to zip files using the Syncfusion.Compression.Zip namespace?](how-to-zip-files-using-the-syncfusion-compression-zip-namespace) * [How to zip all the files in subfolders using Syncfusion® Compression?](how-to-zip-all-the-files-in-subfolders-using-syncfusion-compression) * [How to protect certain cells in a worksheet?](how-to-protect-certain-cells-in-a-worksheet) -* [How to protect Excel workbook?](https://help.syncfusion.com/file-formats/xlsio/migrate-from-office-automation-to-syncfusion-xlsio/protect-excel-workbook) -* [How to protect worksheet?](https://help.syncfusion.com/file-formats/xlsio/security#protect-worksheet) +* [How to protect Excel workbook?](https://help.syncfusion.com/document-processing/excel/excel-library/net/migrate-from-office-automation-to-syncfusion-xlsio/protect-excel-workbook) +* [How to protect worksheet?](https://help.syncfusion.com/document-processing/excel/excel-library/net/security#protect-worksheet) diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-zip-all-the-files-in-subfolders-using-syncfusion-compression.md b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-zip-all-the-files-in-subfolders-using-syncfusion-compression.md index 76daaf00f..1d157e2df 100644 --- a/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-zip-all-the-files-in-subfolders-using-syncfusion-compression.md +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/how-to-zip-all-the-files-in-subfolders-using-syncfusion-compression.md @@ -363,7 +363,7 @@ End Module ## See Also -* [How to zip files using the Syncfusion.Compression.Zip namespace?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-zip-files-using-the-syncfusion-compression-zip-namespace) -* [How to protect the zip files using Syncfusion.Compression.Base?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-protect-the-zip-files-using-syncfusion-compression-base) -* [How to un-protect the zip files using Syncfusion.Compression.Base?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-un-protect-the-zip-files-using-syncfusion-compression-base) -* [How to merge excel files from more than one workbook to a single file?](https://help.syncfusion.com/file-formats/xlsio/faqs/how-to-merge-excel-files-from-more-than-one-workbook-to-a-single-file) +* [How to zip files using the Syncfusion.Compression.Zip namespace?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-zip-files-using-the-syncfusion-compression-zip-namespace) +* [How to protect the zip files using Syncfusion.Compression.Base?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-protect-the-zip-files-using-syncfusion-compression-base) +* [How to un-protect the zip files using Syncfusion.Compression.Base?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-un-protect-the-zip-files-using-syncfusion-compression-base) +* [How to merge excel files from more than one workbook to a single file?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/how-to-merge-excel-files-from-more-than-one-workbook-to-a-single-file) diff --git a/Document-Processing/Excel/Excel-Library/NET/faqs/in-which-situation-we-use-autodetectcomplexscript-converter-property.md b/Document-Processing/Excel/Excel-Library/NET/faqs/in-which-situation-we-use-autodetectcomplexscript-converter-property.md index a46c5aa20..c80fde45d 100644 --- a/Document-Processing/Excel/Excel-Library/NET/faqs/in-which-situation-we-use-autodetectcomplexscript-converter-property.md +++ b/Document-Processing/Excel/Excel-Library/NET/faqs/in-which-situation-we-use-autodetectcomplexscript-converter-property.md @@ -10,14 +10,14 @@ documentation: UG Complex script languages are some languages (eg., Arabic) which stores text differently from how it is displayed. Many such languages use bidirectional script which means, words and sentences are written from right to left, while some text such as numbers and Roman-based words are written from left to right. -If your input Excel file contains such complex script languages, then the [AutoDetectComplexScript](https://help.syncfusion.com/cr/file-formats/Syncfusion.ExcelToPdfConverter.ExcelToPdfConverterSettings.html#Syncfusion_ExcelToPdfConverter_ExcelToPdfConverterSettings_AutoDetectComplexScript) property can be used to render them in PDF. +If your input Excel file contains such complex script languages, then the [AutoDetectComplexScript](https://help.syncfusion.com/cr/document-processing/Syncfusion.ExcelToPdfConverter.ExcelToPdfConverterSettings.html#Syncfusion_ExcelToPdfConverter_ExcelToPdfConverterSettings_AutoDetectComplexScript) property can be used to render them in PDF. ## See Also -* [How to auto-detect complex script?](https://help.syncfusion.com/file-formats/xlsio/excel-to-pdf-converter-settings#auto-detect-complex-script) -* [How to use substitute font in Excel to PDF conversion?](https://help.syncfusion.com/file-formats/xlsio/excel-to-pdf-conversion#substitute-font-in-excel-to-pdf-conversion) -* [How to Embed Fonts?](https://help.syncfusion.com/file-formats/xlsio/excel-to-pdf-converter-settings#embed-fonts) -* [How to capture warnings in Excel to PDF conversion?](https://help.syncfusion.com/file-formats/xlsio/excel-to-pdf-converter-settings#capture-warnings-in-excel-to-pdf-conversion) -* [What is the image quality when using the ExportQualityImage property?](https://help.syncfusion.com/file-formats/xlsio/faqs/what-is-the-image-quality-when-using-the-exportqualityimage-property) +* [How to auto-detect complex script?](https://help.syncfusion.com/document-processing/excel/conversions/excel-to-pdf/net/excel-to-pdf-converter-settings#auto-detect-complex-script) +* [How to use substitute font in Excel to PDF conversion?](https://help.syncfusion.com/document-processing/excel/conversions/excel-to-pdf/net/excel-to-pdf-conversion#substitute-font-in-excel-to-pdf-conversion) +* [How to Embed Fonts?](https://help.syncfusion.com/document-processing/excel/conversions/excel-to-pdf/net/excel-to-pdf-converter-settings#embed-fonts) +* [How to capture warnings in Excel to PDF conversion?](https://help.syncfusion.com/document-processing/excel/conversions/excel-to-pdf/net/excel-to-pdf-converter-settings#capture-warnings-in-excel-to-pdf-conversion) +* [What is the image quality when using the ExportQualityImage property?](https://help.syncfusion.com/document-processing/excel/excel-library/net/faqs/what-is-the-image-quality-when-using-the-exportqualityimage-property) From 3f7be70186bb05831b278442a941a9ce1c078c6e Mon Sep 17 00:00:00 2001 From: Sujitha Siva Date: Fri, 24 Apr 2026 12:19:35 +0530 Subject: [PATCH 007/141] 1023472: Updated React Getting Started --- Document-Processing-toc.html | 2 +- .../Word/Word-Processor/overview.md | 4 +- .../Word-Processor/react/getting-started.md | 224 +----------------- 3 files changed, 12 insertions(+), 218 deletions(-) diff --git a/Document-Processing-toc.html b/Document-Processing-toc.html index 79389eb76..e6484477c 100644 --- a/Document-Processing-toc.html +++ b/Document-Processing-toc.html @@ -3388,7 +3388,7 @@ Word
    • - Word Processor + DOCX Editor SDK
      • ASP.NET Core diff --git a/Document-Processing/Word/Word-Processor/overview.md b/Document-Processing/Word/Word-Processor/overview.md index c4c54da71..9538352b2 100644 --- a/Document-Processing/Word/Word-Processor/overview.md +++ b/Document-Processing/Word/Word-Processor/overview.md @@ -7,7 +7,7 @@ documentation: UG keywords: Word, SDK, view, edit, read, document-editor --- -# Welcome to Syncfusion® Word Processor Component +# Welcome to Syncfusion® DOCX Editor Component -Syncfusion® Word Processor component is a Microsoft Word-like GUI component used to view, edit and print Word documents in WPF, JavaScript, Angular, React, Vue, ASP.NET MVC, ASP.NET Core, and Blazor applications that works without Microsoft Office dependencies. It eases you developers to just integrate this Word editor component to achieve the required Word document viewing, editing functionalities and concentrate on core logics of your application. +Syncfusion® DOCX Editor component is a Microsoft Word-like GUI component used to view, edit and print Word documents in WPF, JavaScript, Angular, React, Vue, ASP.NET MVC, ASP.NET Core, and Blazor applications that works without Microsoft Office dependencies. It eases you developers to just integrate this Word editor component to achieve the required Word document viewing, editing functionalities and concentrate on core logics of your application. diff --git a/Document-Processing/Word/Word-Processor/react/getting-started.md b/Document-Processing/Word/Word-Processor/react/getting-started.md index 130a532ef..275500c79 100644 --- a/Document-Processing/Word/Word-Processor/react/getting-started.md +++ b/Document-Processing/Word/Word-Processor/react/getting-started.md @@ -1,6 +1,6 @@ --- layout: post -title: Getting started with React Document editor component | Syncfusion +title: Getting started with React DOCX editor component | Syncfusion description: Checkout and learn about Getting started with React Document editor component of Syncfusion Essential JS 2 and more details. control: Getting started platform: document-processing @@ -8,11 +8,11 @@ documentation: ug domainurl: ##DomainURL## --- -# Getting started with React Document editor component +# Getting started with React DOCX editor component This section explains the steps to create a Word document editor within your application and demonstrates the basic usage of the Document editor component. -To get started quickly with DocumentEditor component, you can check the video below. +To get started quickly with Document Editor component, you can check the video below. {% youtube "https://www.youtube.com/watch?v=tgJgvbnxdBA" %} @@ -20,49 +20,6 @@ To get started quickly with DocumentEditor component, you can check the video be [System requirements for Syncfusion® Document editor](https://ej2.syncfusion.com/react/documentation/system-requirement) -## Dependencies - -The following list shows the minimum dependencies required to use the Document editor component: - -```javascript -|-- @syncfusion/ej2-react-documenteditor - |-- @syncfusion/ej2-react-base - |-- @syncfusion/ej2-base - |-- @syncfusion/ej2-build - |-- @syncfusion/ej2-buttons - |-- @syncfusion/ej2-compression - |-- @syncfusion/ej2-data - |-- @syncfusion/ej2-dropdowns - |-- @syncfusion/ej2-file-utils - |-- @syncfusion/ej2-inputs - |-- @syncfusion/ej2-lists - |-- @syncfusion/ej2-navigations - |-- @syncfusion/ej2-popups - |-- @syncfusion/ej2-splitbuttons - |-- @syncfusion/ej2-documenteditor - |-- @syncfusion/ej2-charts -``` - -### Server-side dependencies - -The Document editor component requires server-side interactions for the following operations: - -* [Open file formats other than SFDT](./import#convert-word-documents-into-sfdt) -* [Paste with formatting](./clipboard#paste-with-formatting) -* [Restrict editing](./document-management) -* [Spell check](./spell-check) -* [Save as file formats other than SFDT and DOCX](./saving-documents/server-side-export) - ->Note: If you don't require the above functionalities, you can deploy the component as a pure client-side solution without any server-side interactions. - -For detailed information about server-side dependencies, refer to the [Web Services Overview](./web-services-overview) page. - -## Setup for local development - -To easily set up a React application, use `create-vite-app`, which provides a faster development environment, smaller bundle sizes, and optimized builds compared to traditional tools like `create-react-app`. For detailed steps, refer to the Vite [installation instructions](https://vitejs.dev/guide/). Vite sets up your environment using JavaScript and optimizes your application for production. - -> **Note:** To create a React application using `create-react-app`, refer to this [documentation](https://ej2.syncfusion.com/react/documentation/getting-started/create-app) for more details. - ### Create a new React application To create a new React application, run the following command: @@ -71,8 +28,6 @@ To create a new React application, run the following command: npm create vite@latest my-app ``` -### Set up TypeScript environment - To set up a React application in a TypeScript environment, run the following commands: ```bash @@ -81,18 +36,8 @@ cd my-app npm run dev ``` -### Set up JavaScript environment - -To set up a React application in a JavaScript environment, run the following commands: - -```bash -npm create vite@latest my-app -- --template react -cd my-app -npm run dev -``` - -## Adding Syncfusion® packages +## Install the Syncfusion® Document Editor packages All available Essential® JS 2 packages are published in [`npmjs.com`](https://www.npmjs.com/~syncfusionorg) public registry. You can choose the component that you want to install. @@ -103,8 +48,6 @@ To install the Document editor component, use the following command: npm install @syncfusion/ej2-react-documenteditor --save ``` ->Note: The `--save` flag instructs npm to include the Document editor package inside the dependencies section of the `package.json` file. - ## Adding CSS reference Add the Document editor component and its dependent component styles available in the `node_modules/@syncfusion` package folder. Reference these styles in the `src/App.css` file: @@ -118,23 +61,11 @@ Add the Document editor component and its dependent component styles available i @import '../node_modules/@syncfusion/ej2-navigations/styles/material.css'; @import '../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css'; @import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css'; +@import "../node_modules/@syncfusion/ej2-ribbon/styles/material.css"; @import "../node_modules/@syncfusion/ej2-documenteditor/styles/material.css"; ``` ->Note: To learn about individual component CSS files, refer to the [Individual Component theme files](https://ej2.syncfusion.com/react/documentation/appearance/theme#referring-individual-control-theme) section. - -## Choosing a component - -* **DocumentEditorContainer**: A complete solution with a predefined toolbar and properties pane for comprehensive document editing -* **DocumentEditor**: A customizable component where you build the UI according to your specific requirements - ->Note: Starting from version `v19.3.0.x`, the text size measurement accuracy has been optimized to match Microsoft Word pagination for most documents. This improvement is enabled by default. You can [disable it to retain the pagination behavior of older versions](./how-to/disable-optimized-text-measuring) if needed. - -### DocumentEditorContainer component - -The DocumentEditorContainer component provides a complete document editing experience with a predefined toolbar and properties pane, allowing users to create, view, and edit Word documents with minimal configuration. - -#### Adding DocumentEditorContainer component +## Add the Syncfusion® Document Editor component Add the DocumentEditorContainer component to your application. In the `src/App.tsx` file, add the following code to initialize the component: @@ -164,13 +95,14 @@ export default App; > The Web API hosted link `https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/` used in the Document editor's serviceUrl property is intended solely for demonstration and evaluation purposes. For production deployment, host your own web service with the required server configurations. Refer to the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) or use the [Docker image](https://hub.docker.com/r/syncfusion/word-processor-server) for hosting your own web service. -#### Run the DocumentEditorContainer application +#### Run the application -Run the following command in the console to start the development server: +Run the application using the following command: ```bash npm run dev ``` +Open http://localhost:3000 in your browser to see the DocumentEditorContainer output displayed as shown below. The DocumentEditorContainer output will be displayed as follows: @@ -188,142 +120,4 @@ The DocumentEditorContainer output will be displayed as follows: {% previewsample "/document-processing/code-snippet/document-editor/react/base-cs3" %} -### DocumentEditor component - -The DocumentEditor component provides a flexible foundation for creating, viewing, and editing Word documents. Unlike DocumentEditorContainer, this component allows you to customize the UI options based on your specific requirements. - -#### Adding DocumentEditor component - -Add the DocumentEditor component to your application. In the `src/App.tsx` file, add the following code to initialize the component with the required services: - -```ts -import * as React from 'react'; -import { - DocumentEditorComponent, - Print, - SfdtExport, - WordExport, - TextExport, - Selection, - Search, - Editor, - ImageResizer, - EditorHistory, - ContextMenu, - OptionsPane, - HyperlinkDialog, - TableDialog, - BookmarkDialog, - TableOfContentsDialog, - PageSetupDialog, - StyleDialog, - ListDialog, - ParagraphDialog, - BulletsAndNumberingDialog, - FontDialog, - TablePropertiesDialog, - BordersAndShadingDialog, - TableOptionsDialog, - CellOptionsDialog, - StylesDialog -} from '@syncfusion/ej2-react-documenteditor'; - -DocumentEditorComponent.Inject( - Print, - SfdtExport, - WordExport, - TextExport, - Selection, - Search, - Editor, - ImageResizer, - EditorHistory, - ContextMenu, - OptionsPane, - HyperlinkDialog, - TableDialog, - BookmarkDialog, - TableOfContentsDialog, - PageSetupDialog, - StyleDialog, - ListDialog, - ParagraphDialog, - BulletsAndNumberingDialog, - FontDialog, - TablePropertiesDialog, - BordersAndShadingDialog, - TableOptionsDialog, - CellOptionsDialog, - StylesDialog -); - -function App() { - return ( - - ); -} - -export default App; -``` - -> The Web API hosted link `https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/` used in the Document editor's serviceUrl property is intended solely for demonstration and evaluation purposes. For production deployment, host your own web service with the required server configurations. Refer to the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) or use the [Docker image](https://hub.docker.com/r/syncfusion/word-processor-server) for hosting your own web service. - -#### Run the DocumentEditor application - -Run the following command to compile and start the application: - -```bash -npm run dev -``` - -The Document editor output will be displayed as follows: - -{% tabs %} -{% highlight js tabtitle="App.jsx" %} -{% include code-snippet/document-editor/react/base-cs2/app/index.jsx %} -{% endhighlight %} -{% highlight ts tabtitle="App.tsx" %} -{% include code-snippet/document-editor/react/base-cs2/app/index.tsx %} -{% endhighlight %} -{% highlight html tabtitle="App.html" %} -{% include code-snippet/document-editor/react/base-cs2/index.html %} -{% endhighlight %} -{% endtabs %} - -{% previewsample "/document-processing/code-snippet/document-editor/react/base-cs2" %} - -## Frequently Asked Questions -* [How to localize the Document editor container](./global-local) -* [How to load a document by default](./how-to/open-default-document) -* [How to customize the toolbar](./how-to/customize-tool-bar) -* [How to resize the Document editor component](./how-to/resize-document-editor) -* [How to add a save button to the DocumentEditorContainer toolbar](./how-to/add-save-button-in-toolbar) From 25c4671e8c1afba73df65489f76eed523bc9ca61 Mon Sep 17 00:00:00 2001 From: DinakarSF4212 <152485061+DinakarManickam4212@users.noreply.github.com> Date: Fri, 24 Apr 2026 12:43:49 +0530 Subject: [PATCH 008/141] 1021957: Updated Vite details and added installation commands as tabs --- .../Spreadsheet/React/getting-started.md | 114 ++++++++---------- 1 file changed, 47 insertions(+), 67 deletions(-) diff --git a/Document-Processing/Excel/Spreadsheet/React/getting-started.md b/Document-Processing/Excel/Spreadsheet/React/getting-started.md index 872e58322..6e1c5ba9a 100644 --- a/Document-Processing/Excel/Spreadsheet/React/getting-started.md +++ b/Document-Processing/Excel/Spreadsheet/React/getting-started.md @@ -2,72 +2,51 @@ layout: post title: Getting started with React Spreadsheet component | Syncfusion description: Checkout and learn about Getting started with React Spreadsheet component of Syncfusion Essential JS 2 and more details. -control: Getting started +control: Getting started platform: document-processing documentation: ug --- -# Getting started with React Spreadsheet component +# Getting Started with React Spreadsheet component -This section explains the steps to create a simple Spreadsheet component in a React application. +This section explains how to create a simple React application and add the [Syncfusion® React Spreadsheet](https://www.syncfusion.com/spreadsheet-editor-sdk/react-spreadsheet-editor) component with the minimum required setup. -To get start quickly with React Spreadsheet, you can check on this video: +## Prerequisites -{% youtube "https://www.youtube.com/watch?v=3Cx9AnKAHdY" %} - -## Dependencies - -The following list of dependencies are required to use the Spreadsheet component in your application: - -```js -|-- @syncfusion/ej2-react-spreadsheet - |-- @syncfusion/ej2-react-base - |-- @syncfusion/ej2-spreadsheet - |-- @syncfusion/ej2-base - |-- @syncfusion/ej2-dropdowns - |-- @syncfusion/ej2-navigations - |-- @syncfusion/ej2-grids - -``` +[System requirements for Syncfusion® React components](https://ej2.syncfusion.com/react/documentation/system-requirement) -## Setup for Local Development +## Create a React application -To easily set up a React application, use `create-vite-app`, which provides a faster development environment, smaller bundle sizes, and optimized builds compared to traditional tools like `create-react-app`. For detailed steps, refer to the Vite [installation instructions](https://vitejs.dev/guide/). Vite sets up your environment using JavaScript and optimizes your application for production. +Use [`Vite`](https://vite.dev/guide/) to create a new React application, as it provides a faster development environment, smaller bundle sizes, and optimized builds. -> **Note:** To create a React application using `create-react-app`, refer to this [documentation](https://ej2.syncfusion.com/react/documentation/getting-started/create-app) for more details. +To create a new React application, run one of the following commands based on your preferred environment. -To create a new React application, run the following command. +{% tabs %} +{% highlight js tabtitle="JavaScript" %} -```bash -npm create vite@latest my-app -``` -To set-up a React application in TypeScript environment, run the following command. +npm create vite@latest spreadsheet-app -- --template react +cd spreadsheet-app -```bash -npm create vite@latest my-app -- --template react-ts -cd my-app -npm run dev -``` -To set-up a React application in JavaScript environment, run the following command. +{% endhighlight %} +{% highlight ts tabtitle="TypeScript" %} -```bash -npm create vite@latest my-app -- --template react -cd my-app -npm run dev -``` +npm create vite@latest spreadsheet-app -- --template react-ts +cd spreadsheet-app +{% endhighlight %} +{% endtabs %} -## Adding Syncfusion® packages +## Install the Syncfusion® React Spreadsheet package -All the available Essential® JS 2 packages are published in [`npmjs.com`](https://www.npmjs.com/~syncfusionorg) public registry. To install Spreadsheet component use the following command. +Install the [React Spreadsheet](https://www.npmjs.com/package/@syncfusion/ej2-react-spreadsheet) package from npm using the following command: ``` npm install @syncfusion/ej2-react-spreadsheet --save ``` -## Adding CSS reference +## Add CSS references - Add components style as given below in `src/App.css`. +Add the following style references to the `src/App.css` file. ```css @import '../node_modules/@syncfusion/ej2-base/styles/material.css'; @@ -82,45 +61,46 @@ npm install @syncfusion/ej2-react-spreadsheet --save @import '../node_modules/@syncfusion/ej2-react-spreadsheet/styles/material.css'; ``` -> To refer `App.css` in the application then import it in the `src/App.tsx` file. +## Add the Syncfusion® React Spreadsheet component to the application -## Adding Spreadsheet component +Now, import the `SpreadsheetComponent` into your `src/App.jsx` or `src/App.tsx` file and render it. -Now, you can import the spreadsheet component into your `src/App.tsx` file. +{% tabs %} +{% highlight js tabtitle="app.jsx" %} +{% include code-snippet/spreadsheet/react/getting-started-cs1/app/app.jsx %} +{% endhighlight %} +{% highlight ts tabtitle="app.tsx" %} +{% include code-snippet/spreadsheet/react/getting-started-cs1/app/app.tsx %} +{% endhighlight %} +{% endtabs %} -```ts -import * as React from 'react'; -import { SpreadsheetComponent } from '@syncfusion/ej2-react-spreadsheet'; -import './App.css'; -export default function App() { - return (); -} -``` +> **Note:** The [`openUrl`](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#openurl) and [`saveUrl`](https://ej2.syncfusion.com/react/documentation/api/spreadsheet/index-default#saveurl) endpoints used in this example are provided only for demonstration purposes. For development and production use, we strongly recommend configuring your own local or hosted web service for the Open and Save actions instead of relying on the online demo service. For more information, refer to the [`Web Services`](https://help.syncfusion.com/document-processing/excel/spreadsheet/react/web-services/webservice-overview) section. ## Run the application -Now run the `npm run dev` command in the console to start the development server. This command compiles your code and serves the application locally, opening it in the browser. +Run the following command to start the development server: ``` npm run dev ``` -The following example shows a basic spreadsheet component. +After the application starts, open the local URL shown in the terminal to view the React Spreadsheet Editor in the browser. -{% tabs %} -{% highlight js tabtitle="app.jsx" %} -{% include code-snippet/spreadsheet/react/getting-started-cs1/app/app.jsx %} -{% endhighlight %} -{% highlight ts tabtitle="app.tsx" %} -{% include code-snippet/spreadsheet/react/getting-started-cs1/app/app.tsx %} -{% endhighlight %} -{% endtabs %} +The following example shows a basic spreadsheet component. - {% previewsample "/document-processing/code-snippet/spreadsheet/react/getting-started-cs1" %} +{% previewsample "/document-processing/code-snippet/spreadsheet/react/getting-started-cs1" %} > You can refer to our [React Spreadsheet](https://www.syncfusion.com/react-components/react-spreadsheet) feature tour page for its groundbreaking feature representations. You can also explore our [React Spreadsheet example](https://document.syncfusion.com/demos/spreadsheet-editor/react/#/tailwind3/spreadsheet/default) that shows you how to present and manipulate data. -## See Also +## Video tutorial + +To get started quickly with React Spreadsheet, you can watch this video: + +{% youtube "https://www.youtube.com/watch?v=3Cx9AnKAHdY" %} + +## See also * [Data Binding](./data-binding) -* [Open and Save](./open-save) \ No newline at end of file +* [Open Excel files](./open-excel-files) +* [Save Excel files](./save-excel-files) +* [Web Services](./web-services/webservice-overview) From 4fb48302aa86a3ba6f4d64cc907e24508ad7b289 Mon Sep 17 00:00:00 2001 From: Sujitha Siva Date: Fri, 24 Apr 2026 12:52:38 +0530 Subject: [PATCH 009/141] 1023472: Addressed review changes --- Document-Processing-toc.html | 2 +- .../Word/Word-Processor/overview.md | 2 +- .../Word/Word-Processor/react/getting-started.md | 15 +++++---------- 3 files changed, 7 insertions(+), 12 deletions(-) diff --git a/Document-Processing-toc.html b/Document-Processing-toc.html index e6484477c..2027461d5 100644 --- a/Document-Processing-toc.html +++ b/Document-Processing-toc.html @@ -3388,7 +3388,7 @@ Word
        • - DOCX Editor SDK + DOCX Editor
          • ASP.NET Core diff --git a/Document-Processing/Word/Word-Processor/overview.md b/Document-Processing/Word/Word-Processor/overview.md index 9538352b2..9f26da743 100644 --- a/Document-Processing/Word/Word-Processor/overview.md +++ b/Document-Processing/Word/Word-Processor/overview.md @@ -1,6 +1,6 @@ --- title: Microsoft Word-like Word Processor Component | Syncfusion -description: View, edit and print Word documents in WPF, JavaScript, Angular, React, Vue, ASP.NET MVC, ASP.NET Core, and Blazor applications without Microsoft Office dependencies. +description: View, edit and print Word documents in WPF, JavaScript, Angular, React, Vue, ASP.NET MVC, ASP.NET Core, and Blazor applications without Microsoft Office. platform: document-processing control: general documentation: UG diff --git a/Document-Processing/Word/Word-Processor/react/getting-started.md b/Document-Processing/Word/Word-Processor/react/getting-started.md index 275500c79..086a30e2b 100644 --- a/Document-Processing/Word/Word-Processor/react/getting-started.md +++ b/Document-Processing/Word/Word-Processor/react/getting-started.md @@ -10,7 +10,7 @@ domainurl: ##DomainURL## # Getting started with React DOCX editor component -This section explains the steps to create a Word document editor within your application and demonstrates the basic usage of the Document editor component. +This section explains the steps to create a DOCX Editor within your application and demonstrates the basic usage of the Document editor component. To get started quickly with Document Editor component, you can check the video below. @@ -39,8 +39,8 @@ npm run dev ## Install the Syncfusion® Document Editor packages -All available Essential® JS 2 packages are published in [`npmjs.com`](https://www.npmjs.com/~syncfusionorg) public registry. -You can choose the component that you want to install. +The Syncfusion® DOCX Editor package is available in the public npm registry and can be installed directly from [`npmjs.com`](https://www.npmjs.com/~syncfusionorg). + To install the Document editor component, use the following command: @@ -82,6 +82,7 @@ function App() { @@ -93,7 +94,7 @@ export default App; {% endraw %} -> The Web API hosted link `https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/` used in the Document editor's serviceUrl property is intended solely for demonstration and evaluation purposes. For production deployment, host your own web service with the required server configurations. Refer to the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) or use the [Docker image](https://hub.docker.com/r/syncfusion/word-processor-server) for hosting your own web service. +> The hosted Web API URL is for demo and evaluation purposes only. For production, host your own web service using the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices) or the [Docker image](https://hub.docker.com/r/syncfusion/word-processor-server). #### Run the application @@ -107,15 +108,9 @@ Open http://localhost:3000 in your browser to see the DocumentEditorContainer ou The DocumentEditorContainer output will be displayed as follows: {% tabs %} -{% highlight js tabtitle="app.jsx" %} -{% include code-snippet/document-editor/react/base-cs3/app/index.jsx %} -{% endhighlight %} {% highlight ts tabtitle="app.tsx" %} {% include code-snippet/document-editor/react/base-cs3/app/index.tsx %} {% endhighlight %} -{% highlight html tabtitle="app.html" %} -{% include code-snippet/document-editor/react/base-cs3/index.html %} -{% endhighlight %} {% endtabs %} {% previewsample "/document-processing/code-snippet/document-editor/react/base-cs3" %} From 6dae322d28595043685f945f103bd4ee73b6146b Mon Sep 17 00:00:00 2001 From: DinakarSF4212 <152485061+DinakarManickam4212@users.noreply.github.com> Date: Fri, 24 Apr 2026 13:00:45 +0530 Subject: [PATCH 010/141] 1021957: Updated Vite details and added installation commands as tabs --- .../spreadsheet/react/getting-started-cs1/app/app.jsx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.jsx b/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.jsx index f64033395..66052066e 100644 --- a/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.jsx +++ b/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.jsx @@ -3,7 +3,8 @@ import { createRoot } from 'react-dom/client'; import { SpreadsheetComponent } from '@syncfusion/ej2-react-spreadsheet'; export default function App() { - return (); + return (); } const root = createRoot(document.getElementById('root')); -root.render(); \ No newline at end of file +root.render(); From 6dde83e751f06198a881d64e2cbcd1c45cee16d9 Mon Sep 17 00:00:00 2001 From: DinakarSF4212 <152485061+DinakarManickam4212@users.noreply.github.com> Date: Fri, 24 Apr 2026 13:01:25 +0530 Subject: [PATCH 011/141] 1021957: Updated Vite details and added installation commands as tabs --- .../spreadsheet/react/getting-started-cs1/app/app.tsx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.tsx b/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.tsx index dd665327e..2d997438c 100644 --- a/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.tsx +++ b/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.tsx @@ -3,7 +3,8 @@ import { createRoot } from 'react-dom/client'; import { SpreadsheetComponent } from '@syncfusion/ej2-react-spreadsheet'; export default function App() { - return (); + return (); } const root = createRoot(document.getElementById('root')!); -root.render(); \ No newline at end of file +root.render(); From 099b3eb3cf7775d5df119c3a4589675732abcc42 Mon Sep 17 00:00:00 2001 From: DinakarSF4212 <152485061+DinakarManickam4212@users.noreply.github.com> Date: Fri, 24 Apr 2026 13:37:29 +0530 Subject: [PATCH 012/141] 1021957: Updated Vite details and added installation commands as tabs --- .../spreadsheet/react/getting-started-cs1/app/app.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.tsx b/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.tsx index 2d997438c..d73494be5 100644 --- a/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.tsx +++ b/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.tsx @@ -3,8 +3,8 @@ import { createRoot } from 'react-dom/client'; import { SpreadsheetComponent } from '@syncfusion/ej2-react-spreadsheet'; export default function App() { - return (); + return (); } const root = createRoot(document.getElementById('root')!); root.render(); From f901095e1d3c0bd6cb9c69fc5d89d7e5f20a93e7 Mon Sep 17 00:00:00 2001 From: DinakarSF4212 <152485061+DinakarManickam4212@users.noreply.github.com> Date: Fri, 24 Apr 2026 13:38:03 +0530 Subject: [PATCH 013/141] 1021957: Updated Vite details and added installation commands as tabs --- .../spreadsheet/react/getting-started-cs1/app/app.jsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.jsx b/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.jsx index 66052066e..fab8c4732 100644 --- a/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.jsx +++ b/Document-Processing/code-snippet/spreadsheet/react/getting-started-cs1/app/app.jsx @@ -3,8 +3,8 @@ import { createRoot } from 'react-dom/client'; import { SpreadsheetComponent } from '@syncfusion/ej2-react-spreadsheet'; export default function App() { - return (); + return (); } const root = createRoot(document.getElementById('root')); root.render(); From 26cc070181dea181b9f9a2d0054b3c3991ab1ddf Mon Sep 17 00:00:00 2001 From: MOHANRAJSF4991 Date: Fri, 24 Apr 2026 14:07:22 +0530 Subject: [PATCH 014/141] 1021043: refined the getting stated ug content in core --- .../ASP-NET-CORE/getting-started-core.md | 3 +++ .../getting-started-core/spreadsheet.cs | 14 +++++++++++++- .../asp-net-core/getting-started-core/tagHelper | 2 +- 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/Document-Processing/Excel/Spreadsheet/ASP-NET-CORE/getting-started-core.md b/Document-Processing/Excel/Spreadsheet/ASP-NET-CORE/getting-started-core.md index 752280b7a..638d21f26 100644 --- a/Document-Processing/Excel/Spreadsheet/ASP-NET-CORE/getting-started-core.md +++ b/Document-Processing/Excel/Spreadsheet/ASP-NET-CORE/getting-started-core.md @@ -93,6 +93,9 @@ Now, add the Syncfusion® ASP.NET Core Sprea {% highlight cshtml tabtitle="CSHTML" %} {% include code-snippet/spreadsheet/asp-net-core/getting-started-core/tagHelper %} {% endhighlight %} +{% highlight c# tabtitle="OpenController.cs" %} +{% include code-snippet/spreadsheet/asp-net-core/getting-started-core/spreadsheet.cs %} +{% endhighlight %} {% endtabs %} Press Ctrl+F5 (Windows) or +F5 (macOS) to run the app. Then, the Syncfusion® ASP.NET Core Spreadsheet control will be rendered in the default web browser. diff --git a/Document-Processing/code-snippet/spreadsheet/asp-net-core/getting-started-core/spreadsheet.cs b/Document-Processing/code-snippet/spreadsheet/asp-net-core/getting-started-core/spreadsheet.cs index 3a3300bf8..fd28fce05 100644 --- a/Document-Processing/code-snippet/spreadsheet/asp-net-core/getting-started-core/spreadsheet.cs +++ b/Document-Processing/code-snippet/spreadsheet/asp-net-core/getting-started-core/spreadsheet.cs @@ -1,4 +1,16 @@ public IActionResult Index() { return View(); -} \ No newline at end of file +} + +public IActionResult Open(IFormCollection openRequest) +{ + OpenRequest open = new OpenRequest(); + open.File = openRequest.Files[0]; + return Content(Workbook.Open(open)); +} + +public IActionResult Save(SaveSettings saveSettings) +{ + return Workbook.Save(saveSettings); +} diff --git a/Document-Processing/code-snippet/spreadsheet/asp-net-core/getting-started-core/tagHelper b/Document-Processing/code-snippet/spreadsheet/asp-net-core/getting-started-core/tagHelper index c6d8de413..d5aa115a8 100644 --- a/Document-Processing/code-snippet/spreadsheet/asp-net-core/getting-started-core/tagHelper +++ b/Document-Processing/code-snippet/spreadsheet/asp-net-core/getting-started-core/tagHelper @@ -1,3 +1,3 @@ - + \ No newline at end of file From b0ea26ed8c8df013d6e2c5418926fa9d7617222b Mon Sep 17 00:00:00 2001 From: MOHANRAJSF4991 Date: Fri, 24 Apr 2026 14:11:37 +0530 Subject: [PATCH 015/141] 1021043: refined the getting started ug content in mvc platform --- .../Excel/Spreadsheet/ASP-NET-MVC/getting-started-mvc.md | 3 +++ .../spreadsheet/asp-net-mvc/getting-started-mvc/razor | 2 +- .../asp-net-mvc/getting-started-mvc/spreadsheet.cs | 9 +++++++++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/Document-Processing/Excel/Spreadsheet/ASP-NET-MVC/getting-started-mvc.md b/Document-Processing/Excel/Spreadsheet/ASP-NET-MVC/getting-started-mvc.md index 2a4078d2a..51b0bd1d1 100644 --- a/Document-Processing/Excel/Spreadsheet/ASP-NET-MVC/getting-started-mvc.md +++ b/Document-Processing/Excel/Spreadsheet/ASP-NET-MVC/getting-started-mvc.md @@ -90,6 +90,9 @@ Now, add the Syncfusion® ASP.NET MVC Spread {% highlight razor tabtitle="CSHTML" %} {% include code-snippet/spreadsheet/asp-net-mvc/getting-started-mvc/razor %} {% endhighlight %} +{% highlight c# tabtitle="OpenController.cs" %} +{% include code-snippet/spreadsheet/asp-net-mvc/getting-started-core/spreadsheet.cs %} +{% endhighlight %} {% endtabs %} Press Ctrl+F5 (Windows) or +F5 (macOS) to run the app. Then, the Syncfusion® ASP.NET MVC Spreadsheet control will be rendered in the default web browser. diff --git a/Document-Processing/code-snippet/spreadsheet/asp-net-mvc/getting-started-mvc/razor b/Document-Processing/code-snippet/spreadsheet/asp-net-mvc/getting-started-mvc/razor index 0ac89bec3..518d4a15a 100644 --- a/Document-Processing/code-snippet/spreadsheet/asp-net-mvc/getting-started-mvc/razor +++ b/Document-Processing/code-snippet/spreadsheet/asp-net-mvc/getting-started-mvc/razor @@ -1 +1 @@ -@Html.EJS().Spreadsheet("spreadsheet").Render() \ No newline at end of file +@Html.EJS().Spreadsheet("spreadsheet").OpenUrl("Home/Open").SaveUrl("Home/Save").Render() \ No newline at end of file diff --git a/Document-Processing/code-snippet/spreadsheet/asp-net-mvc/getting-started-mvc/spreadsheet.cs b/Document-Processing/code-snippet/spreadsheet/asp-net-mvc/getting-started-mvc/spreadsheet.cs index 2d555a9aa..991fdbfe7 100644 --- a/Document-Processing/code-snippet/spreadsheet/asp-net-mvc/getting-started-mvc/spreadsheet.cs +++ b/Document-Processing/code-snippet/spreadsheet/asp-net-mvc/getting-started-mvc/spreadsheet.cs @@ -1,4 +1,13 @@ public ActionResult Index() { return View(); +} +public ActionResult Open(OpenRequest openRequest) +{ + return Content(Workbook.Open(openRequest)); +} + +public void Save(SaveSettings saveSettings) +{ + Workbook.Save(saveSettings); } \ No newline at end of file From d33e2a8b71bac97c9408f207de1596a0ea2d717f Mon Sep 17 00:00:00 2001 From: gopinathan-sf4977 Date: Fri, 24 Apr 2026 14:38:34 +0530 Subject: [PATCH 016/141] 1019524: Updated the Spreadsheet Angular Getting started --- .../Spreadsheet/Angular/getting-started.md | 149 +++++------------- .../angular/spreadsheet-cs1/src/app.ts | 2 +- 2 files changed, 39 insertions(+), 112 deletions(-) diff --git a/Document-Processing/Excel/Spreadsheet/Angular/getting-started.md b/Document-Processing/Excel/Spreadsheet/Angular/getting-started.md index 3dd6d909d..4a2846147 100644 --- a/Document-Processing/Excel/Spreadsheet/Angular/getting-started.md +++ b/Document-Processing/Excel/Spreadsheet/Angular/getting-started.md @@ -3,103 +3,43 @@ layout: post title: Getting started with Angular Spreadsheet component | Syncfusion description: Checkout and learn here all about getting started with Syncfusion Essential Angular Spreadsheet component, it's elements, and more details. platform: document-processing -control: Getting started +control: Getting started documentation: ug --- -# Getting started with Angular Spreadsheet component +# Getting Started with Angular Spreadsheet component -This section explains the steps to create a simple Spreadsheet component with basic features in an Angular environment. - -To get start quickly with Angular Spreadsheet using CLI, you can check on this video: - -{% youtube "https://www.youtube.com/watch?v=2Ozwe37X-7Q" %} +This section explains how to create a simple Angular application and add the [Syncfusion Angular Spreadsheet](https://www.syncfusion.com/spreadsheet-editor-sdk/angular-spreadsheet-editor) component with the minimum required setup. ## Prerequisites -Ensure your development environment meets the [`System Requirements for Syncfusion® Angular Spreadsheet component`](https://help.syncfusion.com/document-processing/system-requirements). - -## Dependencies - -The following list of dependencies are required to use the Spreadsheet component in your application. - -```js - |-- @syncfusion/ej2-angular-spreadsheet - |-- @syncfusion/ej2-angular-base - |-- @syncfusion/ej2-spreadsheet - |-- @syncfusion/ej2-base - |-- @syncfusion/ej2-dropdowns - |-- @syncfusion/ej2-navigations - |-- @syncfusion/ej2-grids -``` - -## Setup Angular Environment - -You can use [`Angular CLI`](https://github.com/angular/angular-cli) to setup your Angular applications. To install Angular CLI use the following command. - -```bash -npm install -g @angular/cli -``` +[System requirements for Syncfusion® Angular components](https://ej2.syncfusion.com/angular/documentation/system-requirement) ## Create an Angular Application +Use the [`Angular CLI`](https://angular.dev/installation) to create a new Angular application. It is the official and easiest way to get started with Angular. -Start a new Angular application using below Angular CLI command. +To create a new Angular application, run the following commands. -```bash -ng new my-app ``` - -This command prompts you to configure settings such as whether to include Angular routing and which stylesheet format to use. - -```bash - -? Which stylesheet format would you like to use? (Use arrow keys) -> CSS [ https://developer.mozilla.org/docs/Web/CSS ] - Sass (SCSS) [ https://sass-lang.com/documentation/syntax#scss ] - Sass (Indented) [ https://sass-lang.com/documentation/syntax#the-indented-syntax ] - Less [ http://lesscss.org ] - +npm install -g @angular/cli +ng new spreadsheet-app +cd spreadsheet-app ``` -By default, it will create a CSS-based application. - -During project setup, when prompted for the Server-side rendering (SSR) option, choose the appropriate configuration. - -![Spreadsheet showing a comment](./images/gettingstarted_SSR.png) - -Select the required AI tool or ‘none’ if you do not need any AI tool. +## Install the Syncfusion® Angular Spreadsheet package -![Spreadsheet showing a comment](./images/gettingstarted_AI.png) +Currently, Syncfusion® provides two types of package structures for Angular components, +1. Ivy library distribution package [format](https://v17.angular.io/guide/angular-package-format#angular-package-format): -Navigate to the created application folder: +Install the [Angular](https://www.npmjs.com/package/@syncfusion/ej2-angular-spreadsheet) package from npm using the following command: -```bash -cd my-app ``` - -## Installing Syncfusion® Spreadsheet package - -Syncfusion® packages are distributed in npm as `@syncfusion` scoped packages. You can get all the Angular Syncfusion® package from npm [link](https://www.npmjs.com/search?q=%40syncfusion%2Fej2-angular-). - -Currently, Syncfusion® provides two types of package structures for Angular components, -1. Ivy library distribution package [format](https://v17.angular.io/guide/angular-package-format#angular-package-format) -2. Angular compatibility compiler(Angular’s legacy compilation and rendering pipeline) package. - -### Ivy library distribution package - -Syncfusion® Angular packages(`>=20.2.36`) has been moved to the Ivy distribution to support the Angular [Ivy](https://docs.angular.lat/guide/ivy) rendering engine and the package are compatible with Angular version 12 and above. To download the package use the below command. - -Add [`@syncfusion/ej2-angular-spreadsheet`](https://www.npmjs.com/package/@syncfusion/ej2-angular-spreadsheet/v/20.2.38) package to the application. - -```bash npm install @syncfusion/ej2-angular-spreadsheet --save ``` -### Angular compatibility compiled package(ngcc) - -For Angular version below 12, you can use the legacy (ngcc) package of the Syncfusion® Angular components. To download the `ngcc` package use the below. +2. Angular compatibility compiler(Angular’s legacy compilation and rendering pipeline) package. -Add [`@syncfusion/ej2-angular-spreadsheet@ngcc`](https://www.npmjs.com/package/@syncfusion/ej2-angular-spreadsheet/v/20.2.38-ngcc) package to the application. +For Angular version below 12, you can use the legacy (ngcc) package of the Syncfusion® [Angular Spreadsheet](https://www.npmjs.com/package/@syncfusion/ej2-angular-spreadsheet/v/33.2.3-ngcc). To download the `ngcc` package use the below. ```bash npm install @syncfusion/ej2-angular-spreadsheet@ngcc --save @@ -108,21 +48,14 @@ npm install @syncfusion/ej2-angular-spreadsheet@ngcc --save To mention the ngcc package in the `package.json` file, add the suffix `-ngcc` with the package version as below. ```bash -@syncfusion/ej2-angular-spreadsheet:"20.2.38-ngcc" +@syncfusion/ej2-angular-spreadsheet:"33.2.3-ngcc" ``` -The above command does the following configuration to your Angular app, - - * Adds `@syncfusion/ej2-angular-spreadsheet` package and its peer dependencies to your `package.json` file. - * Imports the `SpreadsheetAllModule` in your application module `app.module.ts`. - * Registers the Syncfusion® UI default theme (material) in the `angular.json` file. - >Note: If the ngcc tag is not specified while installing the package, the Ivy Library Package will be installed and this package will throw a warning. -## Adding CSS reference +## Add CSS reference -The following CSS files are available in `../node_modules/@syncfusion` package folder. -This can be referenced in `[src/styles.css]` using following code. +Add the following style references to the `[src/styles.css]` file. ```css @import '../node_modules/@syncfusion/ej2-base/styles/material.css'; @@ -137,25 +70,21 @@ This can be referenced in `[src/styles.css]` using following code. @import '../node_modules/@syncfusion/ej2-grids/styles/material.css'; ``` -## Add Spreadsheet component +## Add the Syncfusion® Angular Spreadsheet component to the application Modify the template in [src/app/app.ts] file to render the spreadsheet component. Add the Angular Spreadsheet by using `` selector in template section of the `app.ts` file. -```typescript -import { Component } from '@angular/core'; -import { SpreadsheetAllModule } from '@syncfusion/ej2-angular-spreadsheet' +{% tabs %} +{% highlight ts tabtitle="app.ts" %} +{% include code-snippet/spreadsheet/angular/spreadsheet-cs1/src/app.ts %} +{% endhighlight %} -@Component({ - imports: [ - SpreadsheetAllModule - ], - selector: 'app-root', - // specifies the template string for the Spreadsheet component - template: ` ` -}) -export class AppComponent { } +{% highlight ts tabtitle="main.ts" %} +{% include code-snippet/spreadsheet/angular/spreadsheet-cs1/src/main.ts %} +{% endhighlight %} +{% endtabs %} -``` +> **Note:** The [`openUrl`](https://ej2.syncfusion.com/angular/documentation/api/spreadsheet/index-default#openurl) and [`saveUrl`](https://ej2.syncfusion.com/angular/documentation/api/spreadsheet/index-default#saveurl) endpoints used in this example are provided only for demonstration purposes. For development and production use, we strongly recommend configuring your own local or hosted web service for the Open and Save actions instead of relying on the online demo service. For more information, refer to the [`Blog Post`](https://www.syncfusion.com/blogs/post/host-spreadsheet-open-and-save-services). ## Run the application @@ -166,22 +95,20 @@ ng serve ``` The following example shows a basic Spreadsheet component - -{% tabs %} -{% highlight ts tabtitle="app.ts" %} -{% include code-snippet/spreadsheet/angular/spreadsheet-cs1/src/app.ts %} -{% endhighlight %} - -{% highlight ts tabtitle="main.ts" %} -{% include code-snippet/spreadsheet/angular/spreadsheet-cs1/src/main.ts %} -{% endhighlight %} -{% endtabs %} - + {% previewsample "/document-processing/samples/spreadsheet/angular/spreadsheet-cs1" %} > You can refer to our [Angular Spreadsheet](https://www.syncfusion.com/spreadsheet-editor-sdk/angular-spreadsheet-editor) feature tour page for its groundbreaking feature representations. You can also explore our [Angular Spreadsheet example](https://document.syncfusion.com/demos/spreadsheet-editor/angular/#/bootstrap5/spreadsheet/default) that shows you how present and manipulate data, including editing, formulas, formatting, importing, and exporting. +## Video tutorial + +To get start quickly with Angular Spreadsheet using CLI, you can check on this video: + +{% youtube "https://www.youtube.com/watch?v=2Ozwe37X-7Q" %} + ## See Also * [Data Binding](./data-binding) -* [Open and Save](./open-save) \ No newline at end of file +* [Open and Save](./open-save) +* [Save Excel files](./save-excel-files) +* [Web Services](./web-services/webservice-overview) \ No newline at end of file diff --git a/Document-Processing/code-snippet/spreadsheet/angular/spreadsheet-cs1/src/app.ts b/Document-Processing/code-snippet/spreadsheet/angular/spreadsheet-cs1/src/app.ts index 8786698d5..2098ee739 100644 --- a/Document-Processing/code-snippet/spreadsheet/angular/spreadsheet-cs1/src/app.ts +++ b/Document-Processing/code-snippet/spreadsheet/angular/spreadsheet-cs1/src/app.ts @@ -10,7 +10,7 @@ imports: [ standalone: true, selector: 'app-root', - template: ' ' + template: ' ' }) export class AppComponent { } From f2c67bf3a5b6e0bee8a303e6bb8b34571de7aeef Mon Sep 17 00:00:00 2001 From: NithishkumarRavikumar Date: Fri, 24 Apr 2026 14:48:46 +0530 Subject: [PATCH 017/141] 1019334: Updated getting started contents for vue --- .../Excel/Spreadsheet/Vue/getting-started.md | 132 ++++------ .../Spreadsheet/Vue/vue-3-getting-started.md | 228 ++++-------------- .../getting-started-cs1/app-composition.vue | 6 +- .../vue/getting-started-cs1/app.vue | 16 +- 4 files changed, 109 insertions(+), 273 deletions(-) diff --git a/Document-Processing/Excel/Spreadsheet/Vue/getting-started.md b/Document-Processing/Excel/Spreadsheet/Vue/getting-started.md index daf90cb54..91a8c5e88 100644 --- a/Document-Processing/Excel/Spreadsheet/Vue/getting-started.md +++ b/Document-Processing/Excel/Spreadsheet/Vue/getting-started.md @@ -2,7 +2,6 @@ layout: post title: Getting started with Vue Spreadsheet component | Syncfusion description: Checkout and learn about Getting started with Vue Spreadsheet component of Syncfusion Essential JS 2 and more details. -control: Getting started platform: document-processing documentation: ug --- @@ -13,67 +12,44 @@ This article provides a step-by-step guide for setting up a Vue 2 project using ## Prerequisites -[System requirements for Syncfusion® Vue UI components](https://ej2.syncfusion.com/vue/documentation/system-requirements/) +[System requirements for Syncfusion® Vue components](https://ej2.syncfusion.com/vue/documentation/system-requirements/) -## Dependencies +## Create a Vue application -The following list of dependencies are required to use the Spreadsheet component in your application: - -```js -|-- @syncfusion/ej2-vue-spreadsheet - |-- @syncfusion/ej2-vue-base - |-- @syncfusion/ej2-base - |-- @syncfusion/ej2-dropdowns - |-- @syncfusion/ej2-navigations - |-- @syncfusion/ej2-grids -``` +To generate a Vue 2 project using Vue-CLI, use the [vue create](https://cli.vuejs.org/#getting-started) command. Follow these steps to install Vue CLI and create a new project: -## Setting up the Vue 2 project +To create a new Vue application, run the following command: -To generate a Vue 2 project using Vue-CLI, use the [vue create](https://cli.vuejs.org/#getting-started) command. Follow these steps to install Vue CLI and create a new project: +{% tabs %} +{% highlight js tabtitle="npm" %} -```bash npm install -g @vue/cli vue create quickstart cd quickstart npm run serve -``` -or +{% endhighlight %} +{% highlight ts tabtitle="yarn" %} -```bash yarn global add @vue/cli vue create quickstart cd quickstart yarn run serve -``` - -When creating a new project, choose the option `Default ([Vue 2] babel, eslint)` from the menu. -![Vue 2 project](./images/vue2-terminal.png) - -Once the `quickstart` project is set up with default settings, proceed to add Syncfusion® components to the project. - -## Add Syncfusion® Vue packages +{% endhighlight %} +{% endtabs %} -Syncfusion® packages are available at [npmjs.com](https://www.npmjs.com/search?q=ej2-vue). To use Vue components, install the required npm package. +## Install the Syncfusion® Vue Spreadsheet package -This article uses the [Vue Spreadsheet component](https://www.syncfusion.com/spreadsheet-editor-sdk/vue-spreadsheet-editor) as an example. Install the `@syncfusion/ej2-vue-spreadsheet` package by running the following command: +Install the [Vue Spreadsheet](https://www.npmjs.com/package/@syncfusion/ej2-vue-spreadsheet) package from npm using the following command: -```bash -npm install @syncfusion/ej2-vue-spreadsheet --save ``` -or - -```bash -yarn add @syncfusion/ej2-vue-spreadsheet +npm install @syncfusion/ej2-vue-spreadsheet --save ``` -## Import Syncfusion® CSS styles - -You can import themes for the Syncfusion® Vue component in various ways, such as using CSS or SASS styles from npm packages, CDN, [CRG](https://ej2.syncfusion.com/javascript/documentation/common/custom-resource-generator/) and [Theme Studio](https://ej2.syncfusion.com/vue/documentation/appearance/theme-studio/). Refer to [themes topic](https://ej2.syncfusion.com/vue/documentation/appearance/theme/) to know more about built-in themes and different ways to refer to themes in a Vue project. +## Add CSS references -In this article, the `Material` theme is applied using CSS styles, which are available in installed packages. The necessary `Material` CSS styles for the Spreadsheet component and its dependents were imported into the ` {% endhighlight %} {% endtabs %} -> The order of importing CSS styles should be in line with its dependency graph. +## Note -> For an enhanced UI experience with the Vue spreadsheet component, kindly remove the basic styles provided in the `scr/styles.css` file. This will help avoid potential styling conflicts and ensure a cleaner design layout. +Refer to [themes topic](https://ej2.syncfusion.com/vue/documentation/appearance/theme/) to know more about built-in themes and different ways to refer to themes in a Vue project. ## Add Syncfusion® Vue component Follow the below steps to add the Vue Spreadsheet component using `Composition API` or `Options API`: - 1.First, import and register the Spreadsheet component and its child directives in the `script` section of the **src/App.vue** file. If you are using the `Composition API`, you should add the `setup` attribute to the `script` tag to indicate that Vue will be using the `Composition API`. - -{% tabs %} -{% highlight html tabtitle="Composition API (~/src/App.vue)" %} - - - -{% endhighlight %} -{% highlight html tabtitle="Options API (~/src/App.vue)" %} - - - -{% endhighlight %} -{% endtabs %} +1.First, import and register the Spreadsheet component and its child directives in the `script` section of the **src/App.vue** file. If you are using the `Composition API`, you should add the `setup` attribute to the `script` tag to indicate that Vue will be using the `Composition API`. 2.In the `template` section, define the Spreadsheet component with sheets directives. Sheet directives are used to define the sheet definition for the Spreadsheet component. -{% tabs %} -{% highlight html tabtitle="~/src/App.vue" %} - - - -{% endhighlight %} -{% endtabs %} - 3.Declare the values for the `dataSource` property in the `script` section. -{% tabs %} -{% highlight html tabtitle="Composition API (~/src/App.vue)" %} - - - -{% endhighlight %} -{% highlight html tabtitle="Options API (~/src/App.vue)" %} - - - -{% endhighlight %} -{% endtabs %} - Here is the summarized code for the above steps in the **src/App.vue** file: {% tabs %} {% highlight html tabtitle="Composition API (~/src/App.vue)" %} @@ -67,15 +66,46 @@ Add the following style references. ## Add the Syncfusion® Vue Spreadsheet component to the application -Import and register the Spreadsheet component in the `script` section of **src/App.vue**. If you use the `Composition API`, add the `setup` attribute to the `script` tag. Then, define the component in the `template` section. +Import and register the Spreadsheet component directives in the `script` section of **src/App.vue**. If you use the `Composition API`, add the `setup` attribute to the `script` tag. Then, define the component in the `template` section with sheets directives. {% tabs %} {% highlight html tabtitle="Composition API (~/src/App.vue)" %} -{% include code-snippet/spreadsheet/vue/getting-started-cs1/app-composition.vue %} +{% raw %} + + + +{% endraw %} {% endhighlight %} - {% highlight html tabtitle="Options API (~/src/App.vue)" %} -{% include code-snippet/spreadsheet/vue/getting-started-cs1/app.vue %} +{% raw %} + + + +{% endraw %} {% endhighlight %} {% endtabs %} diff --git a/Document-Processing/Excel/Spreadsheet/Vue/vue-3-getting-started.md b/Document-Processing/Excel/Spreadsheet/Vue/vue-3-getting-started.md index 58fbf62c0..6d7334cc9 100644 --- a/Document-Processing/Excel/Spreadsheet/Vue/vue-3-getting-started.md +++ b/Document-Processing/Excel/Spreadsheet/Vue/vue-3-getting-started.md @@ -24,7 +24,6 @@ To create a new Vue application, run one of the following commands. ``` npm create vite@latest cd my-project -npm install ``` ## Install the Syncfusion® Vue Spreadsheet package @@ -43,14 +42,14 @@ Add the following style references. {% highlight html tabtitle="~/src/App.vue" %} @@ -61,16 +60,11 @@ Add the following style references. ## Add Syncfusion® Vue component to the application -Follow the below steps to add the Vue Spreadsheet component using `Composition API` or `Options API`: - -1.Import and register the Spreadsheet component in the `script` section of **src/App.vue**. If you use the `Composition API`, add the `setup` attribute to the `script` tag. Then, define the component in the `template` section. - -2.In the `template` section, define the Spreadsheet component with sheets directives. Sheet directives are used to define the sheet definition for the Spreadsheet component. - -3.Declare the values for the `dataSource` property in the `script` section. +Import and register the Spreadsheet component directives in the `script` section of **src/App.vue**. If you use the `Composition API`, add the `setup` attribute to the `script` tag. Then, define the component in the `template` section with sheets directives. {% tabs %} {% highlight html tabtitle="Composition API (~/src/App.vue)" %} +{% raw %}