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

Inherits: Consultingwerk.Utilities.Excel.ExcelUtility
USE-WIDGET-POOL

File:ExcelWorksheetExporter
Author(s):Sebastian Düngel / Consultingwerk Ltd.
Created:Thu Jun 14 11:12:32 CEST 2012
Purpose: Raised when a field label is requested
Notes:

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



Top Method Summary
Options Name Purpose
+ ExportExcel (ExportWorksheetArguments, handle) Export rows from an Progress temp-table to a Excel worksheet
# ExportRows (Worksheet, ExportWorksheetArguments, handle, integer) Exports rows from Progress temp-table to an Excel-Worksheet
+ Microsoft.Office.Interop.Excel.Worksheet GetWorksheet (Workbook, character, integer) Returns the reference to the Worksheet referenced by either Name or Index
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
# OnCompleted (EventArgs) Raises the Completed event
# OnProgressChanged (EventArgs) Raises the ProgressChanged event
# OnRequestFieldLabel (RequestFieldLabelEventArgs) Raises the RequestFieldLabel
+ Microsoft.Office.Interop.Excel.Workbook OpenWorkbook (Application, character) Opens an Excel Workbook
# Microsoft.Office.Interop.Excel.Workbook OpenWorkbook (Application, character, logical) Opens an Excel Workbook
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility

Top Constructor Summary
Options Name Purpose
+ ExcelWorksheetExporter () Constructor for the ExcelWorksheetExporter class

Top Event Summary
Options Name Purpose
+ Completed (Object, EventArgs) Raised when the Export has finished
+ ProgressChanged (Object, EventArgs) Raised when the Export has processed the RowsPerProgressEvent number of rows
+ RequestFieldLabel (Object, RequestFieldLabelEventArgs) Raised when a field label is requested

Top Property Summary
Options Name Purpose
+ INTEGER RowsExported


Method Detail
Top

PUBLIC ExportExcel (ExportWorksheetArguments, handle)
Purpose: Export rows from an Progress temp-table to a Excel worksheet
Notes:

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

PROTECTED ExportRows (Worksheet, ExportWorksheetArguments, handle, integer)
Purpose: Exports rows from Progress temp-table to an Excel-Worksheet
Notes:

Parameters:
poWorksheet Microsoft.Office.Interop.Excel.Worksheet
The reference to the Excel Worksheet
poExportWorksheetArguments Consultingwerk.Utilities.Excel.ExportWorksheetArguments
A reference to an ImportWorksheetArguments instance with the parameters for this method
phTempTable HANDLE
OUTPUT TABLE-HANDLE The temp-table to import to (note the schema for the temp-table is provided by the caller)
piStartRow INTEGER
Sets the Startrow of the Worksheet to be Exported
Top

PUBLIC Microsoft.Office.Interop.Excel.Worksheet GetWorksheet (Workbook, character, integer)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
Purpose: Returns the reference to the Worksheet referenced by either Name or
Index
Notes: The Worksheet name has preference over the index if set

Parameters:
poWorkbook Microsoft.Office.Interop.Excel.Workbook
The reference to the workbook that contains the Worksheet
pcWorksheetName CHARACTER
The name of the worksheet to return
piWorksheetIndex INTEGER
The index (number) of the worksheet to return
Returns Microsoft.Office.Interop.Excel.Worksheet
The reference to the Excel worksheet
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

PROTECTED OnRequestFieldLabel (RequestFieldLabelEventArgs)
Purpose: Raises the RequestFieldLabel
Notes:

Parameters:
e Consultingwerk.Utilities.Excel.RequestFieldLabelEventArgs
The RequestFieldLabelEventArgs with the data for the event
Top

PUBLIC Microsoft.Office.Interop.Excel.Workbook OpenWorkbook (Application, character)
Purpose: Opens an Excel Workbook
Notes:

Parameters:
poExcel Microsoft.Office.Interop.Excel.Application
The reference to an Excel Application instance
pcFileName CHARACTER
The file name of the Workbook to open
Returns Microsoft.Office.Interop.Excel.Workbook
The reference to the Workbook instance
Top

PROTECTED Microsoft.Office.Interop.Excel.Workbook OpenWorkbook (Application, character, logical)
Inherited from Consultingwerk.Utilities.Excel.ExcelUtility
Purpose: Opens an Excel Workbook
Notes:

Parameters:
poExcel Microsoft.Office.Interop.Excel.Application
The reference to an Excel Application instance
pcFileName CHARACTER
The file name of the Workbook to open
plReadOnly LOGICAL
Logical value indicating if the Workbook should be opened read only
Returns Microsoft.Office.Interop.Excel.Workbook
The reference to the Workbook instance


Constructor Detail
Top

PUBLIC ExcelWorksheetExporter ()
Purpose: Constructor for the ExcelWorksheetExporter class
Notes:



Event Detail
Top

PUBLIC Completed (Object, EventArgs)
Purpose: Raised when the Export 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 Export 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
Top

PUBLIC RequestFieldLabel (Object, RequestFieldLabelEventArgs)
Purpose: Raised when a field label is requested
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the RequestFieldLabel event
e Consultingwerk.Utilities.Excel.RequestFieldLabelEventArgs
The RequestFieldLabelEventArgs with the data for the event


Property Detail
Top

PUBLIC INTEGER RowsExported

Returns INTEGER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:17:07