Update v3.0.1

rabanti-github · rabanti-github · commit 4196bd6c8410 · 2026-04-26T04:39:30.000+02:00
diff --git a/Changelog.md b/Changelog.md
@@ -1,5 +1,17 @@
 # Change Log
 
+## v3.0.1
+
+---
+
+Release Date: **(24.04.2026)** <sup>(DMY)</sup>
+
+- Package: **NanoXLSX.Reader**
+  * Fixed internal async handling of the workbook reader, to avoid deadlocks in WinForms/WPF projects, when async is not used (regression).
+  * Fixed order of worksheets when manually changed
+  * Added filename to workbook when reading from file
+
+
 ## v3.0.0
 
 ---
@@ -246,7 +258,7 @@ Release Date: **12.01.2025** <sup>(DMY)</sup>
 Release Date: **24.11.2024** <sup>(DMY)</sup>
 
 - Fixed a bug of the column address (letter) resolution. Column letters above 'Z' were resolved incorrectly
-- Changed async handing of the workbook reader, to avoid deadlocks. Change provided by Jarren Long
+- Changed async handling of the workbook reader, to avoid deadlocks. Change provided by Jarren Long
 - Simplified project structure (unified .Net 4.x and Standard). Change provided by Jarren Long
 - Added tests for column address resolution
 
diff --git a/Docs.IndexGenerator/Config/meta-package-config.json b/Docs.IndexGenerator/Config/meta-package-config.json
@@ -1,5 +1,5 @@
 ﻿{
 "packageName": "NanoXLSX",
-"version": "3.0.0",
+"version": "3.0.1",
 "description": "NanoXLSX is a library to generate and read Microsoft Excel files (XLSX) in an easy and native way. This package is the meta package of NanoXLSX and should be used in most cases as dependency in your project."
 }
diff --git a/NanoXLSX.Reader/Changelog.md b/NanoXLSX.Reader/Changelog.md
@@ -1,5 +1,15 @@
 # Change Log - NanoXLSX.Reader
 
+## v3.0.1
+
+---
+Release Date: **(24.04.2026)** <sup>(DMY)</sup>
+
+- Fixed internal async handling of the workbook reader, to avoid deadlocks in WinForms/WPF projects, when async is not used (regression).
+- Fixed order of worksheets when manually changed
+- Added filename to workbook when reading from file
+
+
 ## v3.0.0
 
 ---
diff --git a/NanoXLSX.Reader/Documentation/projectNumber.doxygen b/NanoXLSX.Reader/Documentation/projectNumber.doxygen
@@ -1 +1 @@
-PROJECT_NUMBER = 3.0.0 
+PROJECT_NUMBER = 3.0.1 
diff --git a/NanoXLSX.Reader/Extensions/WorkbookReader.cs b/NanoXLSX.Reader/Extensions/WorkbookReader.cs
@@ -34,6 +34,7 @@ public static Workbook Load(string filename, ReaderOptions options = null)
             using (XlsxReader reader = new XlsxReader(filename, options))
             {
                 reader.Read();
+                reader.Workbook.Filename = filename;
                 return reader.Workbook;
             }
         }
@@ -66,6 +67,7 @@ public static async Task<Workbook> LoadAsync(string filename, ReaderOptions opti
             using (XlsxReader reader = new XlsxReader(filename, options))
             {
                 await reader.ReadAsync();
+                reader.Workbook.Filename = filename;
                 return reader.Workbook;
             }
         }
diff --git a/NanoXLSX.Reader/Internal/Readers/WorkbookReader.cs b/NanoXLSX.Reader/Internal/Readers/WorkbookReader.cs
@@ -175,6 +175,7 @@ private void GetViewInformation(XmlNodeList nodes)
         /// <param name="nodes">Sheet nodes to check</param>
         private void GetWorksheetInformation(XmlNodeList nodes)
         {
+            int visibleWorksheetOrder = 0;
             foreach (XmlNode node in nodes)
             {
                 if (node.LocalName.Equals("sheet", StringComparison.OrdinalIgnoreCase))
@@ -194,7 +195,8 @@ private void GetWorksheetInformation(XmlNodeList nodes)
                         {
                             Hidden = hidden
                         };
-                        Workbook.AuxiliaryData.SetData(PlugInUUID.WorkbookReader, PlugInUUID.WorksheetDefinitionEntity, id, definition);
+                        Workbook.AuxiliaryData.SetData(PlugInUUID.WorkbookReader, PlugInUUID.WorksheetDefinitionEntity, visibleWorksheetOrder, definition);
+                        visibleWorksheetOrder++;
                     }
                     catch (Exception e)
                     {
diff --git a/NanoXLSX.Reader/Internal/Readers/WorksheetReader.cs b/NanoXLSX.Reader/Internal/Readers/WorksheetReader.cs
@@ -105,7 +105,7 @@ public void Execute()
             try
             {
                 WorksheetDefinition worksheetDefinition = Workbook.AuxiliaryData.GetData<WorksheetDefinition>(PlugInUUID.WorkbookReader, PlugInUUID.WorksheetDefinitionEntity, CurrentWorksheetID);
-                Worksheet worksheet = new Worksheet(worksheetDefinition.WorksheetName, CurrentWorksheetID, Workbook)
+                Worksheet worksheet = new Worksheet(worksheetDefinition.WorksheetName, worksheetDefinition.SheetID, Workbook)
                 {
                     Hidden = worksheetDefinition.Hidden
                 };
@@ -146,7 +146,7 @@ private void SetWorkbookRelation(Worksheet worksheet)
         {
             Workbook.AddWorksheet(worksheet);
             int selectedWorksheetId = Workbook.AuxiliaryData.GetData<int>(PlugInUUID.WorkbookReader, PlugInUUID.SelectedWorksheetEntity);
-            if (selectedWorksheetId + 1 == CurrentWorksheetID) // selectedWorksheetId is 0-based
+            if (selectedWorksheetId == CurrentWorksheetID)
             {
                 Workbook.SetSelectedWorksheet(worksheet);
             }
diff --git a/NanoXLSX.Reader/Internal/Readers/XlsxReader.cs b/NanoXLSX.Reader/Internal/Readers/XlsxReader.cs
@@ -77,7 +77,7 @@ public void Read()
             {
                 using (memoryStream = new MemoryStream())
                 {
-                    ReadInternal().GetAwaiter().GetResult();
+                    Task.Run(() => ReadInternal()).GetAwaiter().GetResult();
                 }
             }
             catch (NotSupportedContentException)
@@ -224,9 +224,10 @@ private void ReadZip(ZipArchive zf)
 
             IWorksheetReader worksheetReader = PlugInLoader.GetPlugIn<IWorksheetReader>(PlugInUUID.WorksheetReader, new WorksheetReader());
             worksheetReader.SharedStrings = sharedStringsReader.SharedStrings;
-            List<WorksheetDefinition> workshetDefinitions = wb.AuxiliaryData.GetDataList<WorksheetDefinition>(PlugInUUID.WorkbookReader, PlugInUUID.WorksheetDefinitionEntity);
             List<Relationship> relationshipDefinitions = wb.AuxiliaryData.GetDataList<Relationship>(PlugInUUID.RelationshipReader, PlugInUUID.RelationshipEntity);
-            foreach (WorksheetDefinition definition in workshetDefinitions)
+            int worksheetVisualIndex = 0;
+            WorksheetDefinition definition;
+            while ((definition = wb.AuxiliaryData.GetData<WorksheetDefinition>(PlugInUUID.WorkbookReader, PlugInUUID.WorksheetDefinitionEntity, worksheetVisualIndex)) != null)
             {
                 Relationship relationship = relationshipDefinitions.SingleOrDefault(r => r.RID == definition.RelId);
                 if (relationship == null)
@@ -235,8 +236,9 @@ private void ReadZip(ZipArchive zf)
                 }
                 ms = GetEntryStream(relationship.Target, zf);
                 worksheetReader.Init(ms, wb, readerOptions, ReaderPlugInHandler.HandleInlineQueuePlugins);
-                worksheetReader.CurrentWorksheetID = definition.SheetID;
+                worksheetReader.CurrentWorksheetID = worksheetVisualIndex;
                 worksheetReader.Execute();
+                worksheetVisualIndex++;
             }
             if (wb.Worksheets.Count == 0)
             {
diff --git a/NanoXLSX.Reader/NanoXLSX.Reader.csproj b/NanoXLSX.Reader/NanoXLSX.Reader.csproj
@@ -20,9 +20,9 @@
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 		<PackageTags>Excel Office XLSX Reader</PackageTags>
-		<Version>3.0.0</Version>
-		<AssemblyVersion>3.0.0.0</AssemblyVersion>
-		<FileVersion>3.0.0.0</FileVersion>
+		<Version>3.0.1</Version>
+		<AssemblyVersion>3.0.1.0</AssemblyVersion>
+		<FileVersion>3.0.1.0</FileVersion>
 		<RepositoryType>git</RepositoryType>
         <PackageReadmeFile>README.md</PackageReadmeFile>
 		<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
diff --git a/NanoXLSX.Writer-Reader.Test/NanoXLSX.Writer-Reader.Test.csproj b/NanoXLSX.Writer-Reader.Test/NanoXLSX.Writer-Reader.Test.csproj
@@ -20,9 +20,9 @@
 		<PackageTags>Excel Office XLSX</PackageTags>
 		<RepositoryType>git</RepositoryType>
 		<PackageReleaseNotes>Please see https://github.com/rabanti-github/NanoXLSX/blob/master/Changelog.md for the release notes</PackageReleaseNotes>
-		<Version>3.0.0</Version>
-		<AssemblyVersion>3.0.0.0</AssemblyVersion>
-		<FileVersion>3.0.0.0</FileVersion>
+		<Version>3.0.1</Version>
+		<AssemblyVersion>3.0.1.0</AssemblyVersion>
+		<FileVersion>3.0.1.0</FileVersion>
 	</PropertyGroup>
 	<ItemGroup>
 	  <None Remove="Resources\autofilter.xlsx" />
@@ -54,6 +54,7 @@
 	  <None Remove="Resources\new_format.xlsx" />
 	  <None Remove="Resources\omitted_style_refs.xlsx" />
 	  <None Remove="Resources\phonetics.xlsx" />
+	  <None Remove="Resources\swapped_worksheets.xlsx" />
 	  <None Remove="Resources\tampered.xlsx" />
 	  <None Remove="Resources\undefined_theme_system_color.xlsx" />
 	  <None Remove="Resources\unknown_style_enums.xlsx" />
@@ -88,6 +89,7 @@
 	  <EmbeddedResource Include="Resources\new_format.xlsx" />
 	  <EmbeddedResource Include="Resources\omitted_style_refs.xlsx" />
 	  <EmbeddedResource Include="Resources\phonetics.xlsx" />
+	  <EmbeddedResource Include="Resources\swapped_worksheets.xlsx" />
 	  <EmbeddedResource Include="Resources\tampered.xlsx" />
 	  <EmbeddedResource Include="Resources\undefined_theme_system_color.xlsx" />
 	  <EmbeddedResource Include="Resources\unknown_style_enums.xlsx" />
diff --git a/NanoXLSX.Writer-Reader.Test/Resources/swapped_worksheets.xlsx b/NanoXLSX.Writer-Reader.Test/Resources/swapped_worksheets.xlsx
diff --git a/NanoXLSX.Writer-Reader.Test/Worksheets/WorksheetWriteReadTest.cs b/NanoXLSX.Writer-Reader.Test/Worksheets/WorksheetWriteReadTest.cs
@@ -4,6 +4,7 @@
 using System.Linq;
 using NanoXLSX.Extensions;
 using NanoXLSX.Styles;
+using NanoXLSX.Test.Writer_Reader.Utils;
 using NanoXLSX.Utils;
 using Xunit;
 using static NanoXLSX.Styles.CellXf;
@@ -628,6 +629,16 @@ public void MixedCellsCellXfTest()
             Assert.Equal(TextBreakValue.ShrinkToFit, givenWorksheet.Cells["A3"].CellStyle.CurrentCellXf.Alignment);
         }
 
+        [Fact(DisplayName = "Test of the correct reading order of worksheets if the worksheets were manually reordered in Excel (WS1 is on pos 2 and WS2 is on pos 1")]
+        public void ReadSwappedWorksheetsTest()
+        {
+            // The file has two worksheets: "Table 2" at index 0 and "Table 1" as index 1
+            Stream stream = TestUtils.GetResource("swapped_worksheets.xlsx");
+            Workbook workbook = WorkbookReader.Load(stream);
+            Assert.Equal("Table 2", workbook.Worksheets[0].SheetName);
+            Assert.Equal("Table 1", workbook.Worksheets[1].SheetName);
+            Assert.Equal(2, workbook.Worksheets.Count);
+        }
 
         private static Dictionary<Worksheet.SheetProtectionValue, bool> PrepareSheetProtectionValues(string tokenString)
         {
diff --git a/NanoXLSX/NanoXLSX.csproj b/NanoXLSX/NanoXLSX.csproj
@@ -24,9 +24,9 @@
     <RepositoryType>git</RepositoryType>
     <PackageTags>Excel Office XLSX</PackageTags>
     <PackageReleaseNotes>Please see https://github.com/rabanti-github/NanoXLSX/blob/master/Changelog.md for the release notes</PackageReleaseNotes>
-    <AssemblyVersion>3.0.0.0</AssemblyVersion>
-    <FileVersion>3.0.0.0</FileVersion>
-	<Version>3.0.0</Version>
+    <AssemblyVersion>3.0.1.0</AssemblyVersion>
+    <FileVersion>3.0.1.0</FileVersion>
+	<Version>3.0.1</Version>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <IncludeSymbols>False</IncludeSymbols>
     <EnableNETAnalyzers>True</EnableNETAnalyzers>
@@ -60,7 +60,7 @@
 
 	<ItemGroup>
 	  <PackageReference Include="NanoXLSX.Core" Version="[3.0.0, 4.0.0)" />
-	  <PackageReference Include="NanoXLSX.Reader" Version="[3.0.0, 4.0.0)" />
+	  <PackageReference Include="NanoXLSX.Reader" Version="[3.0.1, 4.0.0)" />
 	  <PackageReference Include="NanoXLSX.Writer" Version="[3.0.0, 4.0.0)" />
 	  <PackageReference Include="NanoXLSX.Formatting" Version="[3.0.0, 4.0.0)" />
 	</ItemGroup>	
diff --git a/docs/NanoXLSX.png b/docs/NanoXLSX.png
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/style.css b/docs/style.css

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"packageName": "NanoXLSX",`
`3`		`-"version": "3.0.0",`
	`3`	`+"version": "3.0.1",`
`4`	`4`	`"description": "NanoXLSX is a library to generate and read Microsoft Excel files (XLSX) in an easy and native way. This package is the meta package of NanoXLSX and should be used in most cases as dependency in your project."`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-PROJECT_NUMBER = 3.0.0`
	`1`	`+PROJECT_NUMBER = 3.0.1`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ public static Workbook Load(string filename, ReaderOptions options = null)`
`34`	`34`	`using (XlsxReader reader = new XlsxReader(filename, options))`
`35`	`35`	`{`
`36`	`36`	`reader.Read();`
	`37`	`+ reader.Workbook.Filename = filename;`
`37`	`38`	`return reader.Workbook;`
`38`	`39`	`}`
`39`	`40`	`}`
`@@ -66,6 +67,7 @@ public static async Task<Workbook> LoadAsync(string filename, ReaderOptions opti`
`66`	`67`	`using (XlsxReader reader = new XlsxReader(filename, options))`
`67`	`68`	`{`
`68`	`69`	`await reader.ReadAsync();`
	`70`	`+ reader.Workbook.Filename = filename;`
`69`	`71`	`return reader.Workbook;`
`70`	`72`	`}`
`71`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -175,6 +175,7 @@ private void GetViewInformation(XmlNodeList nodes)`
`175`	`175`	`/// <param name="nodes">Sheet nodes to check</param>`
`176`	`176`	`private void GetWorksheetInformation(XmlNodeList nodes)`
`177`	`177`	`{`
	`178`	`+ int visibleWorksheetOrder = 0;`
`178`	`179`	`foreach (XmlNode node in nodes)`
`179`	`180`	`{`
`180`	`181`	`if (node.LocalName.Equals("sheet", StringComparison.OrdinalIgnoreCase))`
`@@ -194,7 +195,8 @@ private void GetWorksheetInformation(XmlNodeList nodes)`
`194`	`195`	`{`
`195`	`196`	`Hidden = hidden`
`196`	`197`	`};`
`197`		`- Workbook.AuxiliaryData.SetData(PlugInUUID.WorkbookReader, PlugInUUID.WorksheetDefinitionEntity, id, definition);`
	`198`	`+ Workbook.AuxiliaryData.SetData(PlugInUUID.WorkbookReader, PlugInUUID.WorksheetDefinitionEntity, visibleWorksheetOrder, definition);`
	`199`	`+ visibleWorksheetOrder++;`
`198`	`200`	`}`
`199`	`201`	`catch (Exception e)`
`200`	`202`	`{`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ public void Execute()`
`105`	`105`	`try`
`106`	`106`	`{`
`107`	`107`	`WorksheetDefinition worksheetDefinition = Workbook.AuxiliaryData.GetData<WorksheetDefinition>(PlugInUUID.WorkbookReader, PlugInUUID.WorksheetDefinitionEntity, CurrentWorksheetID);`
`108`		`- Worksheet worksheet = new Worksheet(worksheetDefinition.WorksheetName, CurrentWorksheetID, Workbook)`
	`108`	`+ Worksheet worksheet = new Worksheet(worksheetDefinition.WorksheetName, worksheetDefinition.SheetID, Workbook)`
`109`	`109`	`{`
`110`	`110`	`Hidden = worksheetDefinition.Hidden`
`111`	`111`	`};`
`@@ -146,7 +146,7 @@ private void SetWorkbookRelation(Worksheet worksheet)`
`146`	`146`	`{`
`147`	`147`	`Workbook.AddWorksheet(worksheet);`
`148`	`148`	`int selectedWorksheetId = Workbook.AuxiliaryData.GetData<int>(PlugInUUID.WorkbookReader, PlugInUUID.SelectedWorksheetEntity);`
`149`		`- if (selectedWorksheetId + 1 == CurrentWorksheetID) // selectedWorksheetId is 0-based`
	`149`	`+ if (selectedWorksheetId == CurrentWorksheetID)`
`150`	`150`	`{`
`151`	`151`	`Workbook.SetSelectedWorksheet(worksheet);`
`152`	`152`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public void Read()`
`77`	`77`	`{`
`78`	`78`	`using (memoryStream = new MemoryStream())`
`79`	`79`	`{`
`80`		`- ReadInternal().GetAwaiter().GetResult();`
	`80`	`+ Task.Run(() => ReadInternal()).GetAwaiter().GetResult();`
`81`	`81`	`}`
`82`	`82`	`}`
`83`	`83`	`catch (NotSupportedContentException)`
`@@ -224,9 +224,10 @@ private void ReadZip(ZipArchive zf)`
`224`	`224`
`225`	`225`	`IWorksheetReader worksheetReader = PlugInLoader.GetPlugIn<IWorksheetReader>(PlugInUUID.WorksheetReader, new WorksheetReader());`
`226`	`226`	`worksheetReader.SharedStrings = sharedStringsReader.SharedStrings;`
`227`		`- List<WorksheetDefinition> workshetDefinitions = wb.AuxiliaryData.GetDataList<WorksheetDefinition>(PlugInUUID.WorkbookReader, PlugInUUID.WorksheetDefinitionEntity);`
`228`	`227`	`List<Relationship> relationshipDefinitions = wb.AuxiliaryData.GetDataList<Relationship>(PlugInUUID.RelationshipReader, PlugInUUID.RelationshipEntity);`
`229`		`- foreach (WorksheetDefinition definition in workshetDefinitions)`
	`228`	`+ int worksheetVisualIndex = 0;`
	`229`	`+ WorksheetDefinition definition;`
	`230`	`+ while ((definition = wb.AuxiliaryData.GetData<WorksheetDefinition>(PlugInUUID.WorkbookReader, PlugInUUID.WorksheetDefinitionEntity, worksheetVisualIndex)) != null)`
`230`	`231`	`{`
`231`	`232`	`Relationship relationship = relationshipDefinitions.SingleOrDefault(r => r.RID == definition.RelId);`
`232`	`233`	`if (relationship == null)`
`@@ -235,8 +236,9 @@ private void ReadZip(ZipArchive zf)`
`235`	`236`	`}`
`236`	`237`	`ms = GetEntryStream(relationship.Target, zf);`
`237`	`238`	`worksheetReader.Init(ms, wb, readerOptions, ReaderPlugInHandler.HandleInlineQueuePlugins);`
`238`		`- worksheetReader.CurrentWorksheetID = definition.SheetID;`
	`239`	`+ worksheetReader.CurrentWorksheetID = worksheetVisualIndex;`
`239`	`240`	`worksheetReader.Execute();`
	`241`	`+ worksheetVisualIndex++;`
`240`	`242`	`}`
`241`	`243`	`if (wb.Worksheets.Count == 0)`
`242`	`244`	`{`