K4 InDesign Javascript API Documentation

PreferencesExcelImportPreference

Excel import preferences.

Extends

Instance Properties

Name Description Access
alignmentStyle AlignmentStyleOptions The cell alignment for the imported document. read-write
decimalPlaces number The number of decimal places to include. Note: Valid only when alignment style is decimal. read-write
errorCode number The import error code. (Key: 0=Success; 1=Empty Sheet; 2=Invalid sheet; 3=Invalid range; 4=Invalid View; 5=Misc. Error) read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent Application The parent of the ExcelImportPreference (a Application). read-only
preserveGraphics bool If true, preserves inline graphics. read-write
properties Object A property that allows setting of several properties at the same time. read-write
rangeName string The range of cells to import. Note: Use a colon (:) to separate the start and end cell names in the range. read-write
sheetIndex number The worksheet's index. For information, see sheet name. read-write
sheetName string The worksheet to import. read-write
showHiddenCells bool If true, shows hidden cells. read-write
tableFormatting TableFormattingOptions The format for imported spreadsheets. read-write
useTypographersQuotes bool If true, convert straight quotes and apostrophes in the imported text to typographic quotation marks and apostrophes. read-write
viewName string The stored custom or personal view(s) to import with the file. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → ExcelImportPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → ExcelImportPreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the ExcelImportPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.