Class
Excel import preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
ExcelImportPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| alignmentStyle | AlignmentStyleOptions: AlignmentStyleOptions.SPREADSHEET AlignmentStyleOptions.LEFT_ALIGN AlignmentStyleOptions.RIGHT_ALIGN AlignmentStyleOptions.CENTER_ALIGN |
r/w | The cell alignment for the imported document. |
| decimalPlaces | number | r/w | The number of decimal places to include. Note: Valid only when alignment style is decimal. |
| errorCode | number | r/w | The import error code. (Key: 0=Success; 1=Empty Sheet; 2=Invalid sheet; 3=Invalid range; 4=Invalid View; 5=Misc. Error) |
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | Application | readonly | The parent of the ExcelImportPreference (a Application). |
| preserveGraphics | bool | r/w | If true, preserves inline graphics. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rangeName | string | r/w | The range of cells to import. Note: Use a colon (:) to separate the start and end cell names in the range. |
| sheetIndex | number | r/w | The worksheet's index. For information, see sheet name. |
| sheetName | string | r/w | The worksheet to import. |
| showHiddenCells | bool | r/w | If true, shows hidden cells. |
| tableFormatting | TableFormattingOptions: TableFormattingOptions.EXCEL_FORMATTED_TABLE TableFormattingOptions.EXCEL_UNFORMATTED_TABLE TableFormattingOptions.EXCEL_UNFORMATTED_TABBED_TEXT TableFormattingOptions.EXCEL_FORMAT_ONLY_ONCE |
r/w | The format for imported spreadsheets. |
| useTypographersQuotes | bool | r/w | If true, convert straight quotes and apostrophes in the imported text to typographic quotation marks and apostrophes. |
| viewName | string | r/w | The stored custom or personal view(s) to import with the file. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of ExcelImportPreference getElements ()
Resolves the object specifier, creating an array of object references.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the ExcelImportPreference.
Element of
Application.excelImportPreferences
Return
Array of ExcelImportPreference ExcelImportPreference.getElements ()
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |