Package | com.adobe.indesign |
Class | public class ExcelImportPreference |
Inheritance | ExcelImportPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerExcelImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | ExcelImportPreference | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | ExcelImportPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
alignmentStyle | property |
alignmentStyle:AlignmentStyleOptions
Since : | CS5 |
The cell alignment for the imported document.
public function get alignmentStyle():AlignmentStyleOptions
public function set alignmentStyle(value:AlignmentStyleOptions):void
decimalPlaces | property |
decimalPlaces:Number
Since : | CS5 |
The number of decimal places to include. Note: Valid only when alignment style is decimal.
public function get decimalPlaces():Number
public function set decimalPlaces(value:Number):void
errorCode | property |
errorCode:Number
Since : | CS5 |
The import error code. (Key: 0=Success; 1=Empty Sheet; 2=Invalid sheet; 3=Invalid range; 4=Invalid View; 5=Misc. Error)
public function get errorCode():Number
public function set errorCode(value:Number):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the ExcelImportPreference (a Application).
public function get parent():Object
preserveGraphics | property |
preserveGraphics:Boolean
Since : | CS5 |
If true, preserves inline graphics.
public function get preserveGraphics():Boolean
public function set preserveGraphics(value:Boolean):void
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
rangeName | property |
rangeName:String
Since : | CS5 |
The range of cells to import. Note: Use a colon (:) to separate the start and end cell names in the range.
public function get rangeName():String
public function set rangeName(value:String):void
sheetIndex | property |
sheetIndex:Number
Since : | CS5 |
The worksheet's index. For information, see sheet name.
public function get sheetIndex():Number
public function set sheetIndex(value:Number):void
sheetName | property |
sheetName:String
Since : | CS5 |
The worksheet to import.
public function get sheetName():String
public function set sheetName(value:String):void
showHiddenCells | property |
showHiddenCells:Boolean
Since : | CS5 |
If true, shows hidden cells.
public function get showHiddenCells():Boolean
public function set showHiddenCells(value:Boolean):void
tableFormatting | property |
tableFormatting:TableFormattingOptions
Since : | CS5 |
The format for imported spreadsheets.
public function get tableFormatting():TableFormattingOptions
public function set tableFormatting(value:TableFormattingOptions):void
useTypographersQuotes | property |
useTypographersQuotes:Boolean
Since : | CS5 |
If true, convert straight quotes and apostrophes in the imported text to typographic quotation marks and apostrophes.
public function get useTypographersQuotes():Boolean
public function set useTypographersQuotes(value:Boolean):void
viewName | property |
viewName:String
Since : | CS5 |
The stored custom or personal view(s) to import with the file.
public function get viewName():String
public function set viewName(value:String):void
addEventListenerExcelImportPreference | () | method |
public function addEventListenerExcelImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerExcelImportPreference | () | method |
public function removeEventListenerExcelImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |