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

Inherits: Progress.Lang.Object

File:ImportWorksheetArguments
Purpose:Parameter class for the Import method of the ExcelWorksheetImporter
class
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Feb 26 12:26:08 CET 2012

Navigate to: Methods | Constructors | Events | Properties


Top Constructor Summary
Options Name Purpose
+ ImportWorksheetArguments () Default constructor for the InportImportWorksheetsArguments class
+ ImportWorksheetArguments (character) Constructor for the InportImportWorksheetsArguments class
+ ImportWorksheetArguments (character, character) Constructor for the InportImportWorksheetsArguments class
+ ImportWorksheetArguments (character, integer) Constructor for the InportImportWorksheetsArguments class

Top Property Summary
Options Name Purpose
+ CHARACTER FileName Gets and sets the FileName of the Excel Workbook to be imported
+ INTEGER ImportRows Gets and sets the Number of rows to be imported
+ INTEGER RaiseProgressChangedAfter Gets and sets the number of importeds rows after which the ExcelWorksheetImported instance should raise the ProgressChanged event
+ INTEGER SkipRowsFromTop Gets and sets the number of rows from the top of the document that should be skipped (column header etc.)
+ INTEGER StopAfterEmptyRows Gets and sets the Number of empty rows after which the import will be stopped
+ INTEGER WorksheetIndex Gets and sets the index (number) of the Worksheet to be imported
+ CHARACTER WorksheetName Gets and sets the name of the Worksheet to be imported


Constructor Detail
Top

PUBLIC ImportWorksheetArguments ()
Purpose: Default constructor for the InportImportWorksheetsArguments class
Notes:

Top

PUBLIC ImportWorksheetArguments (character)
Purpose: Constructor for the InportImportWorksheetsArguments class
Notes:

Parameters:
pcFileName CHARACTER
The filename of the Worksheet to be imported
Top

PUBLIC ImportWorksheetArguments (character, character)
Purpose: Constructor for the InportImportWorksheetsArguments class
Notes:

Parameters:
pcFileName CHARACTER
The filename of the Worksheet to be imported
pcWorksheetName CHARACTER
The name of the worksheet to import
Top

PUBLIC ImportWorksheetArguments (character, integer)
Purpose: Constructor for the InportImportWorksheetsArguments class
Notes:

Parameters:
pcFileName CHARACTER
The filename of the Worksheet to be imported
piWorksheetIndex INTEGER
The index of the worksheet to import


Property Detail
Top

PUBLIC CHARACTER FileName
Purpose: Gets and sets the FileName of the Excel Workbook to be imported
Notes:

Returns CHARACTER
Top

PUBLIC INTEGER ImportRows
Purpose: Gets and sets the Number of rows to be imported
Notes:

Returns INTEGER
Top

PUBLIC INTEGER RaiseProgressChangedAfter
Purpose: Gets and sets the number of importeds rows after which the
ExcelWorksheetImported instance should raise the ProgressChanged
event
Notes:

Returns INTEGER
Top

PUBLIC INTEGER SkipRowsFromTop
Purpose: Gets and sets the number of rows from the top of the document that
should be skipped (column header etc.)
Notes: Defaults to 1

Returns INTEGER
Top

PUBLIC INTEGER StopAfterEmptyRows
Purpose: Gets and sets the Number of empty rows after which the import will
be stopped
Notes: Defaults to 1, use ? to turn off

Returns INTEGER
Top

PUBLIC INTEGER WorksheetIndex
Purpose: Gets and sets the index (number) of the Worksheet to be imported
Notes: This property is used as an alternative to the WorksheetName property
1 based index

Returns INTEGER
Top

PUBLIC CHARACTER WorksheetName
Purpose: Gets and sets the name of the Worksheet to be imported
Notes: This property is used as an alternative to the WorksheetIndex property
When the WorksheetName is set, this property has preference

Returns CHARACTER


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:47:04