Namespace: Consultingwerk.Utilities.Excel
Class 
ExcelWorksheetImporter Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Utilities.Excel.ExcelUtility
Consultingwerk.Utilities.Excel.ExcelWorksheetImporter

Inherits: Consultingwerk.Utilities.Excel.ExcelUtility
Implements: Consultingwerk.Utilities.Excel.IExcelWorksheetImporter

Purpose: Raised when the import has finished
Notes:

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ CloseSpreadsheetDocument (SpreadsheetDocument) Closes the SpreadsheetDocument by calling the Dispose method.
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
- ExtractRowValues (WorkbookPart, Row, Object[]) Extracts the values from the parameter poValues and populates the Individual Cell Values for the specified Row
+ CHARACTER GetCellValue (WorkbookPart, Cell) Gets and returns the Value of a Cell
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
+ DocumentFormat.OpenXml.Spreadsheet.Cell GetRowCell (Row, character) Gets the Cell Object from a Row
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
+ DocumentFormat.OpenXml.Packaging.WorkbookPart GetWorkbookPart (SpreadsheetDocument) Gets and returns the WorkbookPart of the specified SpreadsheetDocument
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
+ DocumentFormat.OpenXml.Packaging.WorksheetPart GetWorksheetPart (WorkbookPart) Gets and returns the WorksheetPart of the specified WorkbookPart
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
+ DocumentFormat.OpenXml.Spreadsheet.SheetData GetWorksheetSheetData (WorkbookPart) Gets and returns the WorksheetSheetData of the specified WorkbookPart
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
+ Import (ImportWorksheetArguments, table-handle) Imports from an Excel Worksheet into a Temp-Table
# ImportRows (WorkbookPart, SheetData, ImportWorksheetArguments, table-handle) Imports rows from an Excel worksheet to a Progress temp-table
+ InsertCellValue (WorksheetPart, character, integer, character) Inserts a Cell Value into the indexed Row and Column of an Excel Worksheet
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
# OnCompleted (EventArgs) Raises the Completed event
# OnProgressChanged (EventArgs) Raises the ProgressChanged event
+ DocumentFormat.OpenXml.Packaging.SpreadsheetDocument OpenSpreadsheetDocument (character, logical) Opens the SpreadsheetDocument
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
+ SaveSpreadsheetDocument (SpreadsheetDocument) Saves and closes the SpreadsheetDocument
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
+ SaveWorkbook (WorkbookPart) Saves the Workbook element of the specified WorkbookPart
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
+ SetExcelCellValues (WorksheetPart, integer, Object[]) Sets the Excel Cell Values based on the provided values Object[]
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility

Top Event Summary
Options Name Purpose
+ Completed (Object, EventArgs) Raised when the import has finished
+ ProgressChanged (Object, EventArgs) Raised when the import has processed the RowsPerProgressEvent number of rows

Top Property Summary
Options Name Purpose
- CHARACTER ColumnReferences
+ INTEGER RowsImported


Method Detail
Top

PUBLIC CloseSpreadsheetDocument (SpreadsheetDocument)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
/*
Purpose: Closes the SpreadsheetDocument by calling the Dispose method.
Notes: The Dispose is important to release the memory and close the file.
(otherwise the file will be locked and cannot be opened)

Parameters:
poSpreadsheetDocument DocumentFormat.OpenXml.Packaging.SpreadsheetDocument
Top

PRIVATE ExtractRowValues (WorkbookPart, Row, Object[])
/*
Purpose: Extracts the values from the parameter poValues and populates the Individual Cell Values
for the specified Row
Notes:

Parameters:
poWorkbookPart DocumentFormat.OpenXml.Packaging.WorkbookPart
The reference to the Excel WorkbookPart
poRow DocumentFormat.OpenXml.Spreadsheet.Row
Row
poValues System.Object[]
Array of values
Top

PUBLIC CHARACTER GetCellValue (WorkbookPart, Cell)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
/*
Purpose: Gets and returns the Value of a Cell
Notes:

Parameters:
poWorkbookPart DocumentFormat.OpenXml.Packaging.WorkbookPart
poCell DocumentFormat.OpenXml.Spreadsheet.Cell
Returns CHARACTER
Cell Value
Top

PUBLIC DocumentFormat.OpenXml.Spreadsheet.Cell GetRowCell (Row, character)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
/*
Purpose: Gets the Cell Object from a Row
Notes:

Parameters:
poRow DocumentFormat.OpenXml.Spreadsheet.Row
pcCellReference CHARACTER
Returns DocumentFormat.OpenXml.Spreadsheet.Cell
Cell Object
Top

PUBLIC DocumentFormat.OpenXml.Packaging.WorkbookPart GetWorkbookPart (SpreadsheetDocument)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
/*
Purpose: Gets and returns the WorkbookPart of the specified SpreadsheetDocument
Notes:

Parameters:
oSpreadsheetDocument DocumentFormat.OpenXml.Packaging.SpreadsheetDocument
Returns DocumentFormat.OpenXml.Packaging.WorkbookPart
WorkbookPart Object
Top

PUBLIC DocumentFormat.OpenXml.Packaging.WorksheetPart GetWorksheetPart (WorkbookPart)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
/*
Purpose: Gets and returns the WorksheetPart of the specified WorkbookPart
Notes:

Parameters:
poWorkbookPart DocumentFormat.OpenXml.Packaging.WorkbookPart
Returns DocumentFormat.OpenXml.Packaging.WorksheetPart
WorksheetPart Object
Top

PUBLIC DocumentFormat.OpenXml.Spreadsheet.SheetData GetWorksheetSheetData (WorkbookPart)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
/*
Purpose: Gets and returns the WorksheetSheetData of the specified WorkbookPart
Notes:

Parameters:
poWorkbookPart DocumentFormat.OpenXml.Packaging.WorkbookPart
Returns DocumentFormat.OpenXml.Spreadsheet.SheetData
SheetData Object
Top

PUBLIC Import (ImportWorksheetArguments, table-handle)
Purpose: Imports from an Excel Worksheet into a Temp-Table
Notes:

Parameters:
poImportWorksheetArguments Consultingwerk.Utilities.Excel.ImportWorksheetArguments
A reference to an ImportWorksheetArguments instance with the parameters for this method
phTempTable TABLE-HANDLE
OUTPUT TABLE-HANDLE The temp-table to import to (note the schema for the temp-table is provided by the caller BY-REFERENCE)
Top

PROTECTED ImportRows (WorkbookPart, SheetData, ImportWorksheetArguments, table-handle)
Purpose: Imports rows from an Excel worksheet to a Progress temp-table
Notes:

Parameters:
poWorkbookPart DocumentFormat.OpenXml.Packaging.WorkbookPart
The reference to the Excel WorkbookPart
poSheetData DocumentFormat.OpenXml.Spreadsheet.SheetData
The Excel SheetData
poImportWorksheetArguments Consultingwerk.Utilities.Excel.ImportWorksheetArguments
A reference to an ImportWorksheetArguments instance with the parameters for this method
phTempTable TABLE-HANDLE
OUTPUT TABLE-HANDLE The temp-table to import to (note the schema for the temp-table is provided by the caller)
Top

PUBLIC InsertCellValue (WorksheetPart, character, integer, character)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
Purpose: Inserts a Cell Value into the indexed Row and Column of an Excel Worksheet
Notes:

Parameters:
poWorksheetPart DocumentFormat.OpenXml.Packaging.WorksheetPart
WorksheetPart
pcContent CHARACTER
Character The content to insert
piRowIndex INTEGER
Integer The row to insert into
pcCol CHARACTER
Character The column to insert into
Top

PROTECTED OnCompleted (EventArgs)
Purpose: Raises the Completed event
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs instance for the event
Top

PROTECTED OnProgressChanged (EventArgs)
Purpose: Raises the ProgressChanged event
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs instance for the event
Top

PUBLIC DocumentFormat.OpenXml.Packaging.SpreadsheetDocument OpenSpreadsheetDocument (character, logical)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
/*
Purpose: Opens the SpreadsheetDocument
Notes: The second attribute is optional and defaults to false. If set to true the document will be opened in update mode.

Parameters:
pcFileName CHARACTER
plEditable LOGICAL
Returns DocumentFormat.OpenXml.Packaging.SpreadsheetDocument
SpreadsheetDocument Object
Top

PUBLIC SaveSpreadsheetDocument (SpreadsheetDocument)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
/*
Purpose: Saves and closes the SpreadsheetDocument
Notes:

Parameters:
poSpreadsheetDocument DocumentFormat.OpenXml.Packaging.SpreadsheetDocument
Top

PUBLIC SaveWorkbook (WorkbookPart)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
/*
Purpose: Saves the Workbook element of the specified WorkbookPart
Notes:

Parameters:
poWorkbookPart DocumentFormat.OpenXml.Packaging.WorkbookPart
Top

PUBLIC SetExcelCellValues (WorksheetPart, integer, Object[])
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
Purpose: Sets the Excel Cell Values based on the provided values Object[]
Notes:

Parameters:
poWorksheetPart DocumentFormat.OpenXml.Packaging.WorksheetPart
WorksheetPart
piCount INTEGER
Integer The row to insert into
poValues System.Object[]
Object[] The values to insert


Event Detail
Top

PUBLIC Completed (Object, EventArgs)
Purpose: Raised when the import has finished
Notes:

Parameters:
sender Progress.Lang.Object
The instance the raised the event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs instance for this event
Top

PUBLIC ProgressChanged (Object, EventArgs)
Purpose: Raised when the import has processed the RowsPerProgressEvent number
of rows
Notes:

Parameters:
sender Progress.Lang.Object
The instance the raised the event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs instance for this event


Property Detail
Top

PRIVATE CHARACTER ColumnReferences

Returns CHARACTER
Top

PUBLIC INTEGER RowsImported

Returns INTEGER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       25.01.2026 20:51:30