Packagecom.adobe.indesign
Classpublic class ExcelImportPreference
InheritanceExcelImportPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  alignmentStyle : AlignmentStyleOptions
The cell alignment for the imported document.
ExcelImportPreference
  decimalPlaces : Number
The number of decimal places to include.
ExcelImportPreference
  errorCode : Number
The import error code.
ExcelImportPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
ExcelImportPreference
  events : Events
[override] [read-only] A collection of events.
ExcelImportPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
ExcelImportPreference
  parent : Object
[override] [read-only] The parent of the ExcelImportPreference (a Application).
ExcelImportPreference
  preserveGraphics : Boolean
If true, preserves inline graphics.
ExcelImportPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
ExcelImportPreference
  rangeName : String
The range of cells to import.
ExcelImportPreference
  sheetIndex : Number
The worksheet's index.
ExcelImportPreference
  sheetName : String
The worksheet to import.
ExcelImportPreference
  showHiddenCells : Boolean
If true, shows hidden cells.
ExcelImportPreference
  tableFormatting : TableFormattingOptions
The format for imported spreadsheets.
ExcelImportPreference
  useTypographersQuotes : Boolean
If true, convert straight quotes and apostrophes in the imported text to typographic quotation marks and apostrophes.
ExcelImportPreference
  viewName : String
The stored custom or personal view(s) to import with the file.
ExcelImportPreference
Public Methods
 MethodDefined By
  
addEventListenerExcelImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
ExcelImportPreference
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
ExcelImportPreference
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
removeEventListenerExcelImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
ExcelImportPreference
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
ExcelImportPreference
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
alignmentStyleproperty
alignmentStyle:AlignmentStyleOptions

The cell alignment for the imported document.


Implementation
    public function get alignmentStyle():AlignmentStyleOptions
    public function set alignmentStyle(value:AlignmentStyleOptions):void
decimalPlacesproperty 
decimalPlaces:Number

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


Implementation
    public function get decimalPlaces():Number
    public function set decimalPlaces(value:Number):void
errorCodeproperty 
errorCode:Number

The import error code. (Key: 0=Success; 1=Empty Sheet; 2=Invalid sheet; 3=Invalid range; 4=Invalid View; 5=Misc. Error)


Implementation
    public function get errorCode():Number
    public function set errorCode(value:Number):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
parentproperty 
parent:Object  [read-only] [override]

The parent of the ExcelImportPreference (a Application).


Implementation
    public function get parent():Object
preserveGraphicsproperty 
preserveGraphics:Boolean

If true, preserves inline graphics.


Implementation
    public function get preserveGraphics():Boolean
    public function set preserveGraphics(value:Boolean):void
propertiesproperty 
properties:Object[override]

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


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
rangeNameproperty 
rangeName:String

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


Implementation
    public function get rangeName():String
    public function set rangeName(value:String):void
sheetIndexproperty 
sheetIndex:Number

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


Implementation
    public function get sheetIndex():Number
    public function set sheetIndex(value:Number):void
sheetNameproperty 
sheetName:String

The worksheet to import.


Implementation
    public function get sheetName():String
    public function set sheetName(value:String):void
showHiddenCellsproperty 
showHiddenCells:Boolean

If true, shows hidden cells.


Implementation
    public function get showHiddenCells():Boolean
    public function set showHiddenCells(value:Boolean):void
tableFormattingproperty 
tableFormatting:TableFormattingOptions

The format for imported spreadsheets.


Implementation
    public function get tableFormatting():TableFormattingOptions
    public function set tableFormatting(value:TableFormattingOptions):void
useTypographersQuotesproperty 
useTypographersQuotes:Boolean

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


Implementation
    public function get useTypographersQuotes():Boolean
    public function set useTypographersQuotes(value:Boolean):void
viewNameproperty 
viewName:String

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


Implementation
    public function get viewName():String
    public function set viewName(value:String):void
Method Detail
addEventListenerExcelImportPreference()method
public function addEventListenerExcelImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
getElements()method 
override public function getElements():Object

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

Returns
Object
removeEventListenerExcelImportPreference()method 
public function removeEventListenerExcelImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String