ExcelImportPreference

Excel import preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

AlignmentStyleOptions, Boolean, EventListeners, Events, Number, Object, String, TableFormattingOptions

Hierarchy:

Superclass: Preference

Class: ExcelImportPreference

Property Listing

Property

Type

Access

Description

alignmentStyle

AlignmentStyleOptions

AlignmentStyleOptions.CENTER_ALIGN

AlignmentStyleOptions.LEFT_ALIGN

AlignmentStyleOptions.RIGHT_ALIGN

AlignmentStyleOptions.SPREADSHEET

read/write

The cell alignment for the imported document.

decimalPlaces

Number

read/write

The number of decimal places to include. Note: Valid only when alignment style is decimal.

errorCode

Number

read/write

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

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Application

readonly

The parent of the ExcelImportPreference (a Application).

preserveGraphics

Boolean

read/write

If true, preserves inline graphics.

properties

Object

read/write

A property that allows setting of several properties at the same time.

rangeName

String

read/write

The range of cells to import. Note: Use a colon (:) to separate the start and end cell names in the range.

sheetIndex

Number

read/write

The worksheet's index. For information, see sheet name.

sheetName

String

read/write

The worksheet to import.

showHiddenCells

Boolean

read/write

If true, shows hidden cells.

tableFormatting

TableFormattingOptions

TableFormattingOptions.EXCEL_FORMATTED_TABLE

TableFormattingOptions.EXCEL_FORMAT_ONLY_ONCE

TableFormattingOptions.EXCEL_UNFORMATTED_TABBED_TEXT

TableFormattingOptions.EXCEL_UNFORMATTED_TABLE

read/write

The format for imported spreadsheets.

useTypographersQuotes

Boolean

read/write

If true, convert straight quotes and apostrophes in the imported text to typographic quotation marks and apostrophes.

viewName

String

read/write

The stored custom or personal view(s) to import with the file.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

ExcelImportPreference getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the ExcelImportPreference.

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.excelImportPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

ExcelImportPreference.getElements()