Skip to content

Bound EPPlus4 XLSX loading resources #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jochenwezel merged 1 commit into from
Oct 1, 2026
Merged

Bound EPPlus4 XLSX loading resources #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CM.Data.EpplusFixCalcsEdition/CM.Data.EpplusFreeFixCalcsEdition.vbproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<PackageReadmeFile>README.md</PackageReadmeFile>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<OptionStrict>On</OptionStrict>
<DefineConstants>CM_FIXCALCS=True</DefineConstants>
<RepositoryUrl>https://github.com/CompuMasterGmbH/CompuMaster.Excel.git</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<IncludeSymbols>True</IncludeSymbols>
Expand Down
70 changes: 67 additions & 3 deletions CM.Data.EpplusFixCalcsEdition/XlsEpplusFixCalcsEdition.vb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,34 @@ Namespace CompuMaster.Data

Me.FirstRowContainsColumnNames = firstRowContainsColumnNames
Me.StartReadingAtRowIndex = startReadingAtRowIndex
#If CM_FIXCALCS Then
Me.PackageLoadLimits = CompuMaster.Epplus4.ExcelPackageLoadLimits.Default
#End If
End Sub

#If CM_FIXCALCS Then
''' <summary>
''' Initializes read options with explicit XLSX resource limits.
''' </summary>
''' <param name="firstRowContainsColumnNames">Indicates whether the first imported row contains column names.</param>
''' <param name="startReadingAtRowIndex">The zero-based row index at which reading starts.</param>
''' <param name="packageLoadLimits">The resource limits to apply while opening the XLSX file.</param>
''' <exception cref="ArgumentNullException"><paramref name="packageLoadLimits"/> is <see langword="Nothing"/>.</exception>
''' <exception cref="ArgumentOutOfRangeException"><paramref name="startReadingAtRowIndex"/> is negative.</exception>
Public Sub New(firstRowContainsColumnNames As Boolean, startReadingAtRowIndex As Integer, packageLoadLimits As CompuMaster.Epplus4.ExcelPackageLoadLimits)
Me.New(firstRowContainsColumnNames, startReadingAtRowIndex)
If packageLoadLimits Is Nothing Then
Throw New ArgumentNullException(NameOf(packageLoadLimits))
End If
Me.PackageLoadLimits = packageLoadLimits
End Sub

''' <summary>
''' Gets the resource limits applied while opening an XLSX file.
''' </summary>
Public ReadOnly Property PackageLoadLimits As CompuMaster.Epplus4.ExcelPackageLoadLimits
#End If

''' <summary>
''' Gets whether the first imported row contains column names.
''' </summary>
Expand Down Expand Up @@ -758,7 +784,11 @@ Namespace CompuMaster.Data
Dim importWorkbook As CompuMaster.Epplus4.ExcelPackage

'Load the worksheet
#If CM_FIXCALCS Then
importWorkbook = LoadWorkbookFile(inputPath, options.PackageLoadLimits)
#Else
importWorkbook = LoadWorkbookFile(inputPath)
#End If

Dim Result As New DataSet

Expand Down Expand Up @@ -789,6 +819,16 @@ Namespace CompuMaster.Data
Return importWorkbook
End Function

#If CM_FIXCALCS Then
Private Shared Function LoadWorkbookFile(inputPath As String, loadLimits As CompuMaster.Epplus4.ExcelPackageLoadLimits) As CompuMaster.Epplus4.ExcelPackage
Dim file As New System.IO.FileInfo(inputPath)
If Not file.Exists Then
Throw New System.IO.FileNotFoundException("Missing file: " & file.ToString(), file.ToString())
End If
Return CompuMaster.Epplus4.ExcelPackage.OpenWithLoadLimits(file, loadLimits)
End Function
#End If

''' <summary>
''' Reads the data from an excel sheet into a datatable.
''' </summary>
Expand Down Expand Up @@ -822,7 +862,7 @@ Namespace CompuMaster.Data
''' <exception cref="ArgumentNullException"><paramref name="inputPath"/> or <paramref name="options"/> is <see langword="Nothing"/>.</exception>
Public Shared Function ReadDataTableFromXlsFileWithOptions(ByVal inputPath As String, ByVal options As ReadOptions) As DataTable
options = RequiredReadOptions(options)
Return ReadDataTableFromXlsFile(inputPath, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames)
Return ReadDataTableFromXlsFileCore(inputPath, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames, options)
End Function

''' <summary>
Expand Down Expand Up @@ -871,6 +911,10 @@ Namespace CompuMaster.Data
''' {blank} --> DBNull
''' </remarks>
Public Shared Function ReadDataTableFromXlsFile(ByVal inputPath As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean) As DataTable
Return ReadDataTableFromXlsFileCore(inputPath, startReadingAtRowIndex, firstRowContainsColumnNames, Nothing)
End Function

Private Shared Function ReadDataTableFromXlsFileCore(ByVal inputPath As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean, ByVal options As ReadOptions) As DataTable

If inputPath = Nothing OrElse (New System.IO.FileInfo(inputPath)).FullName = Nothing Then
Throw New ArgumentNullException(NameOf(inputPath), "The input filename is required")
Expand All @@ -879,7 +923,11 @@ Namespace CompuMaster.Data
Dim importWorkbook As CompuMaster.Epplus4.ExcelPackage

'Save the changed worksheet
#If CM_FIXCALCS Then
importWorkbook = If(options Is Nothing, LoadWorkbookFile(inputPath), LoadWorkbookFile(inputPath, options.PackageLoadLimits))
#Else
importWorkbook = LoadWorkbookFile(inputPath)
#End If
Dim Sheet As CompuMaster.Epplus4.ExcelWorksheet = importWorkbook.Workbook.Worksheets(0)

'Detect the column types which must be used
Expand Down Expand Up @@ -926,7 +974,7 @@ Namespace CompuMaster.Data
''' <exception cref="ArgumentNullException"><paramref name="inputPath"/> or <paramref name="options"/> is <see langword="Nothing"/>.</exception>
Public Shared Function ReadDataTableFromXlsFileWithOptions(ByVal inputPath As String, ByVal sheetName As String, ByVal options As ReadOptions) As DataTable
options = RequiredReadOptions(options)
Return ReadDataTableFromXlsFile(inputPath, sheetName, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames)
Return ReadDataTableFromXlsFileCore(inputPath, sheetName, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames, options)
End Function

''' <summary>
Expand Down Expand Up @@ -973,14 +1021,22 @@ Namespace CompuMaster.Data
''' {blank} --> DBNull
''' </remarks>
Public Shared Function ReadDataTableFromXlsFile(ByVal inputPath As String, ByVal sheetName As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean) As DataTable
Return ReadDataTableFromXlsFileCore(inputPath, sheetName, startReadingAtRowIndex, firstRowContainsColumnNames, Nothing)
End Function

Private Shared Function ReadDataTableFromXlsFileCore(ByVal inputPath As String, ByVal sheetName As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean, ByVal options As ReadOptions) As DataTable
If inputPath = Nothing OrElse (New System.IO.FileInfo(inputPath)).FullName = Nothing Then
Throw New ArgumentNullException(NameOf(inputPath), "The input filename is required")
End If

Dim importWorkbook As CompuMaster.Epplus4.ExcelPackage

'Save the changed worksheet
#If CM_FIXCALCS Then
importWorkbook = If(options Is Nothing, LoadWorkbookFile(inputPath), LoadWorkbookFile(inputPath, options.PackageLoadLimits))
#Else
importWorkbook = LoadWorkbookFile(inputPath)
#End If
If sheetName = Nothing Then
sheetName = importWorkbook.Workbook.Worksheets.First.Name
End If
Expand Down Expand Up @@ -1033,7 +1089,7 @@ Namespace CompuMaster.Data
''' <exception cref="ArgumentNullException"><paramref name="inputPath"/>, <paramref name="options"/>, or <paramref name="data"/> is <see langword="Nothing"/>.</exception>
Public Shared Sub ReadDataTableFromXlsFileWithOptions(ByVal inputPath As String, ByVal sheetName As String, ByVal options As ReadOptions, ByVal data As DataTable)
options = RequiredReadOptions(options)
ReadDataTableFromXlsFile(inputPath, sheetName, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames, data)
ReadDataTableFromXlsFileCore(inputPath, sheetName, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames, data, options)
End Sub

''' <summary>
Expand Down Expand Up @@ -1086,6 +1142,10 @@ Namespace CompuMaster.Data
''' Dependent on the firstRowContainsColumnNames parameter, the datatable parameter must contain a table with column names as they're defined in the first row of the excel sheet or the table's columnn must have the name of the column index in excel ("1", "2", "3", ...)
''' </remarks>
Public Shared Sub ReadDataTableFromXlsFile(ByVal inputPath As String, ByVal sheetName As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean, ByVal data As DataTable)
ReadDataTableFromXlsFileCore(inputPath, sheetName, startReadingAtRowIndex, firstRowContainsColumnNames, data, Nothing)
End Sub

Private Shared Sub ReadDataTableFromXlsFileCore(ByVal inputPath As String, ByVal sheetName As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean, ByVal data As DataTable, ByVal options As ReadOptions)

If inputPath = Nothing OrElse (New System.IO.FileInfo(inputPath)).FullName = Nothing Then
Throw New ArgumentNullException(NameOf(inputPath), "The input filename is required")
Expand All @@ -1096,7 +1156,11 @@ Namespace CompuMaster.Data
Dim importWorkbook As CompuMaster.Epplus4.ExcelPackage

'Save the changed worksheet
#If CM_FIXCALCS Then
importWorkbook = If(options Is Nothing, LoadWorkbookFile(inputPath), LoadWorkbookFile(inputPath, options.PackageLoadLimits))
#Else
importWorkbook = LoadWorkbookFile(inputPath)
#End If
If sheetName = Nothing Then
sheetName = importWorkbook.Workbook.Worksheets.First.Name
End If
Expand Down
70 changes: 67 additions & 3 deletions CM.Data.EpplusPolyformEdition/XlsEpplusPolyformEdition.vb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,34 @@

Me.FirstRowContainsColumnNames = firstRowContainsColumnNames
Me.StartReadingAtRowIndex = startReadingAtRowIndex
#If CM_FIXCALCS Then
Me.PackageLoadLimits = OfficeOpenXml.ExcelPackageLoadLimits.Default
#End If
End Sub

#If CM_FIXCALCS Then
''' <summary>
''' Initializes read options with explicit XLSX resource limits.
''' </summary>
''' <param name="firstRowContainsColumnNames">Indicates whether the first imported row contains column names.</param>
''' <param name="startReadingAtRowIndex">The zero-based row index at which reading starts.</param>
''' <param name="packageLoadLimits">The resource limits to apply while opening the XLSX file.</param>
''' <exception cref="ArgumentNullException"><paramref name="packageLoadLimits"/> is <see langword="Nothing"/>.</exception>
''' <exception cref="ArgumentOutOfRangeException"><paramref name="startReadingAtRowIndex"/> is negative.</exception>
Public Sub New(firstRowContainsColumnNames As Boolean, startReadingAtRowIndex As Integer, packageLoadLimits As OfficeOpenXml.ExcelPackageLoadLimits)
Me.New(firstRowContainsColumnNames, startReadingAtRowIndex)
If packageLoadLimits Is Nothing Then
Throw New ArgumentNullException(NameOf(packageLoadLimits))
End If
Me.PackageLoadLimits = packageLoadLimits
End Sub

''' <summary>
''' Gets the resource limits applied while opening an XLSX file.
''' </summary>
Public ReadOnly Property PackageLoadLimits As OfficeOpenXml.ExcelPackageLoadLimits
#End If

''' <summary>
''' Gets whether the first imported row contains column names.
''' </summary>
Expand Down Expand Up @@ -353,7 +379,7 @@
''' <param name="outputPath"></param>
''' <remarks></remarks>
Private Shared Sub SaveWorkbook(ByVal exportWorkbook As OfficeOpenXml.ExcelPackage, ByVal outputPath As String)
If outputPath <> Nothing AndAlso outputPath.ToLower.EndsWith(".xlsb") Then

Check warning on line 382 in CM.Data.EpplusPolyformEdition/XlsEpplusPolyformEdition.vb

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest) 

Specify a culture or use an invariant version to avoid implicit dependency on current culture (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1311)
'Excel 2007 binary format
Throw New NotSupportedException("Excel2007 binary file format not supported yet")
ElseIf outputPath <> Nothing AndAlso outputPath.ToLower.EndsWith(".xlsm") Then
Expand Down Expand Up @@ -758,7 +784,11 @@
Dim importWorkbook As OfficeOpenXml.ExcelPackage

'Load the worksheet
#If CM_FIXCALCS Then
importWorkbook = LoadWorkbookFile(inputPath, options.PackageLoadLimits)
#Else
importWorkbook = LoadWorkbookFile(inputPath)
#End If

Dim Result As New DataSet

Expand Down Expand Up @@ -789,6 +819,16 @@
Return importWorkbook
End Function

#If CM_FIXCALCS Then
Private Shared Function LoadWorkbookFile(inputPath As String, loadLimits As OfficeOpenXml.ExcelPackageLoadLimits) As OfficeOpenXml.ExcelPackage
Dim file As New System.IO.FileInfo(inputPath)
If Not file.Exists Then
Throw New System.IO.FileNotFoundException("Missing file: " & file.ToString(), file.ToString())
End If
Return OfficeOpenXml.ExcelPackage.OpenWithLoadLimits(file, loadLimits)
End Function
#End If

''' <summary>
''' Reads the data from an excel sheet into a datatable.
''' </summary>
Expand Down Expand Up @@ -822,7 +862,7 @@
''' <exception cref="ArgumentNullException"><paramref name="inputPath"/> or <paramref name="options"/> is <see langword="Nothing"/>.</exception>
Public Shared Function ReadDataTableFromXlsFileWithOptions(ByVal inputPath As String, ByVal options As ReadOptions) As DataTable
options = RequiredReadOptions(options)
Return ReadDataTableFromXlsFile(inputPath, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames)
Return ReadDataTableFromXlsFileCore(inputPath, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames, options)
End Function

''' <summary>
Expand Down Expand Up @@ -871,6 +911,10 @@
''' {blank} --> DBNull
''' </remarks>
Public Shared Function ReadDataTableFromXlsFile(ByVal inputPath As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean) As DataTable
Return ReadDataTableFromXlsFileCore(inputPath, startReadingAtRowIndex, firstRowContainsColumnNames, Nothing)
End Function

Private Shared Function ReadDataTableFromXlsFileCore(ByVal inputPath As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean, ByVal options As ReadOptions) As DataTable

If inputPath = Nothing OrElse (New System.IO.FileInfo(inputPath)).FullName = Nothing Then
Throw New ArgumentNullException(NameOf(inputPath), "The input filename is required")
Expand All @@ -879,7 +923,11 @@
Dim importWorkbook As OfficeOpenXml.ExcelPackage

'Save the changed worksheet
#If CM_FIXCALCS Then
importWorkbook = If(options Is Nothing, LoadWorkbookFile(inputPath), LoadWorkbookFile(inputPath, options.PackageLoadLimits))
#Else
importWorkbook = LoadWorkbookFile(inputPath)
#End If
Dim Sheet As OfficeOpenXml.ExcelWorksheet = importWorkbook.Workbook.Worksheets(0)

'Detect the column types which must be used
Expand Down Expand Up @@ -926,7 +974,7 @@
''' <exception cref="ArgumentNullException"><paramref name="inputPath"/> or <paramref name="options"/> is <see langword="Nothing"/>.</exception>
Public Shared Function ReadDataTableFromXlsFileWithOptions(ByVal inputPath As String, ByVal sheetName As String, ByVal options As ReadOptions) As DataTable
options = RequiredReadOptions(options)
Return ReadDataTableFromXlsFile(inputPath, sheetName, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames)
Return ReadDataTableFromXlsFileCore(inputPath, sheetName, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames, options)
End Function

''' <summary>
Expand Down Expand Up @@ -973,14 +1021,22 @@
''' {blank} --> DBNull
''' </remarks>
Public Shared Function ReadDataTableFromXlsFile(ByVal inputPath As String, ByVal sheetName As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean) As DataTable
Return ReadDataTableFromXlsFileCore(inputPath, sheetName, startReadingAtRowIndex, firstRowContainsColumnNames, Nothing)
End Function

Private Shared Function ReadDataTableFromXlsFileCore(ByVal inputPath As String, ByVal sheetName As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean, ByVal options As ReadOptions) As DataTable
If inputPath = Nothing OrElse (New System.IO.FileInfo(inputPath)).FullName = Nothing Then
Throw New ArgumentNullException(NameOf(inputPath), "The input filename is required")
End If

Dim importWorkbook As OfficeOpenXml.ExcelPackage

'Save the changed worksheet
#If CM_FIXCALCS Then
importWorkbook = If(options Is Nothing, LoadWorkbookFile(inputPath), LoadWorkbookFile(inputPath, options.PackageLoadLimits))
#Else
importWorkbook = LoadWorkbookFile(inputPath)
#End If
If sheetName = Nothing Then
sheetName = importWorkbook.Workbook.Worksheets.First.Name
End If
Expand Down Expand Up @@ -1033,7 +1089,7 @@
''' <exception cref="ArgumentNullException"><paramref name="inputPath"/>, <paramref name="options"/>, or <paramref name="data"/> is <see langword="Nothing"/>.</exception>
Public Shared Sub ReadDataTableFromXlsFileWithOptions(ByVal inputPath As String, ByVal sheetName As String, ByVal options As ReadOptions, ByVal data As DataTable)
options = RequiredReadOptions(options)
ReadDataTableFromXlsFile(inputPath, sheetName, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames, data)
ReadDataTableFromXlsFileCore(inputPath, sheetName, options.StartReadingAtRowIndex, options.FirstRowContainsColumnNames, data, options)
End Sub

''' <summary>
Expand Down Expand Up @@ -1086,6 +1142,10 @@
''' Dependent on the firstRowContainsColumnNames parameter, the datatable parameter must contain a table with column names as they're defined in the first row of the excel sheet or the table's columnn must have the name of the column index in excel ("1", "2", "3", ...)
''' </remarks>
Public Shared Sub ReadDataTableFromXlsFile(ByVal inputPath As String, ByVal sheetName As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean, ByVal data As DataTable)
ReadDataTableFromXlsFileCore(inputPath, sheetName, startReadingAtRowIndex, firstRowContainsColumnNames, data, Nothing)
End Sub

Private Shared Sub ReadDataTableFromXlsFileCore(ByVal inputPath As String, ByVal sheetName As String, ByVal startReadingAtRowIndex As Integer, ByVal firstRowContainsColumnNames As Boolean, ByVal data As DataTable, ByVal options As ReadOptions)

If inputPath = Nothing OrElse (New System.IO.FileInfo(inputPath)).FullName = Nothing Then
Throw New ArgumentNullException(NameOf(inputPath), "The input filename is required")
Expand All @@ -1096,7 +1156,11 @@
Dim importWorkbook As OfficeOpenXml.ExcelPackage

'Save the changed worksheet
#If CM_FIXCALCS Then
importWorkbook = If(options Is Nothing, LoadWorkbookFile(inputPath), LoadWorkbookFile(inputPath, options.PackageLoadLimits))
#Else
importWorkbook = LoadWorkbookFile(inputPath)
#End If
If sheetName = Nothing Then
sheetName = importWorkbook.Workbook.Worksheets.First.Name
End If
Expand Down
Loading
Loading