Adobe InDesign CS5 Server (7.0) Object Model JS: ExcelImportPreference

InDesign Server CS5

Class

ExcelImportPreference

 Excel import preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
ExcelImportPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
alignmentStyleAlignmentStyleOptions:
AlignmentStyleOptions.SPREADSHEET
AlignmentStyleOptions.LEFT_ALIGN
AlignmentStyleOptions.RIGHT_ALIGN
AlignmentStyleOptions.CENTER_ALIGN
r/wThe cell alignment for the imported document.
decimalPlacesnumber r/wThe number of decimal places to include. Note: Valid only when alignment style is decimal.
errorCodenumber r/wThe import error code. (Key: 0=Success; 1=Empty Sheet; 2=Invalid sheet; 3=Invalid range; 4=Invalid View; 5=Misc. Error)
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication readonlyThe parent of the ExcelImportPreference (a Application).
preserveGraphicsbool r/wIf true, preserves inline graphics.
propertiesObject r/wA property that allows setting of several properties at the same time.
rangeNamestring r/wThe range of cells to import. Note: Use a colon (:) to separate the start and end cell names in the range.
sheetIndexnumber r/wThe worksheet's index. For information, see sheet name.
sheetNamestring r/wThe worksheet to import.
showHiddenCellsbool r/wIf true, shows hidden cells.
tableFormattingTableFormattingOptions:
TableFormattingOptions.EXCEL_FORMATTED_TABLE
TableFormattingOptions.EXCEL_UNFORMATTED_TABLE
TableFormattingOptions.EXCEL_UNFORMATTED_TABBED_TEXT
TableFormattingOptions.EXCEL_FORMAT_ONLY_ONCE
r/wThe format for imported spreadsheets.
useTypographersQuotesbool r/wIf true, convert straight quotes and apostrophes in the imported text to typographic quotation marks and apostrophes.
viewNamestring r/wThe 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.excelImportPreferences

Return

Array of ExcelImportPreference ExcelImportPreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index