Packagecom.adobe.indesign
Classpublic class WordRTFImportPreference
InheritanceWordRTFImportPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  convertBulletsAndNumbersToText : Boolean
If true, bullets and numbers will be converted to embedded characters during import.
WordRTFImportPreference
  convertPageBreaks : ConvertPageBreaks
The option for handling manual page breaks.
WordRTFImportPreference
  convertTablesTo : ConvertTablesOptions
The policy for converting tables whose formatting has been removed.
WordRTFImportPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
WordRTFImportPreference
  events : Events
[override] [read-only] A collection of events.
WordRTFImportPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  importEndnotes : Boolean
If true, imports endnotes.
WordRTFImportPreference
  importFootnotes : Boolean
If true, imports footnotes.
WordRTFImportPreference
  importIndex : Boolean
If true, imports the index.
WordRTFImportPreference
  importTOC : Boolean
If true, imports the table of contents.
WordRTFImportPreference
  importUnusedStyles : Boolean
If true, imports unused styles.
WordRTFImportPreference
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
WordRTFImportPreference
  parent : Object
[override] [read-only] The parent of the WordRTFImportPreference (a Application).
WordRTFImportPreference
  preserveGraphics : Boolean
If true, preserves inline graphics.
WordRTFImportPreference
  preserveLocalOverrides : Boolean
If true, maintains character formatting in text whose formatting has been removed.
WordRTFImportPreference
  preserveTrackChanges : Boolean
If true, preserves comments and edits in the imported file.
WordRTFImportPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
WordRTFImportPreference
  removeFormatting : Boolean
If true, removes text and table formatting.
WordRTFImportPreference
  resolveCharacterStyleClash : ResolveStyleClash
The option for handling style name conflicts.
WordRTFImportPreference
  resolveParagraphStyleClash : ResolveStyleClash
The option for resolving conflicts that arise when paragraph styles have matching names.
WordRTFImportPreference
  useTypographersQuotes : Boolean
If true, convert straight quotes and apostrophes in the imported text to typographic quotation marks and apostrophes.
WordRTFImportPreference
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerWordRTFImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
WordRTFImportPreference
 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.
WordRTFImportPreference
 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
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
  
removeEventListenerWordRTFImportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
WordRTFImportPreference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
WordRTFImportPreference
 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
convertBulletsAndNumbersToTextproperty
convertBulletsAndNumbersToText:Boolean

If true, bullets and numbers will be converted to embedded characters during import. If false, bullets and numbers will be rendered by InDesign.


Implementation
    public function get convertBulletsAndNumbersToText():Boolean
    public function set convertBulletsAndNumbersToText(value:Boolean):void
convertPageBreaksproperty 
convertPageBreaks:ConvertPageBreaks

The option for handling manual page breaks.


Implementation
    public function get convertPageBreaks():ConvertPageBreaks
    public function set convertPageBreaks(value:ConvertPageBreaks):void
convertTablesToproperty 
convertTablesTo:ConvertTablesOptions

The policy for converting tables whose formatting has been removed. Note: Valid when remove formatting is true.


Implementation
    public function get convertTablesTo():ConvertTablesOptions
    public function set convertTablesTo(value:ConvertTablesOptions):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
importEndnotesproperty 
importEndnotes:Boolean

If true, imports endnotes.


Implementation
    public function get importEndnotes():Boolean
    public function set importEndnotes(value:Boolean):void
importFootnotesproperty 
importFootnotes:Boolean

If true, imports footnotes.


Implementation
    public function get importFootnotes():Boolean
    public function set importFootnotes(value:Boolean):void
importIndexproperty 
importIndex:Boolean

If true, imports the index.


Implementation
    public function get importIndex():Boolean
    public function set importIndex(value:Boolean):void
importTOCproperty 
importTOC:Boolean

If true, imports the table of contents.


Implementation
    public function get importTOC():Boolean
    public function set importTOC(value:Boolean):void
importUnusedStylesproperty 
importUnusedStyles:Boolean

If true, imports unused styles.


Implementation
    public function get importUnusedStyles():Boolean
    public function set importUnusedStyles(value:Boolean):void
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 WordRTFImportPreference (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
preserveLocalOverridesproperty 
preserveLocalOverrides:Boolean

If true, maintains character formatting in text whose formatting has been removed. Note: Valid when remove formatting is true.


Implementation
    public function get preserveLocalOverrides():Boolean
    public function set preserveLocalOverrides(value:Boolean):void
preserveTrackChangesproperty 
preserveTrackChanges:Boolean

If true, preserves comments and edits in the imported file.


Implementation
    public function get preserveTrackChanges():Boolean
    public function set preserveTrackChanges(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
removeFormattingproperty 
removeFormatting:Boolean

If true, removes text and table formatting.


Implementation
    public function get removeFormatting():Boolean
    public function set removeFormatting(value:Boolean):void
resolveCharacterStyleClashproperty 
resolveCharacterStyleClash:ResolveStyleClash

The option for handling style name conflicts.


Implementation
    public function get resolveCharacterStyleClash():ResolveStyleClash
    public function set resolveCharacterStyleClash(value:ResolveStyleClash):void
resolveParagraphStyleClashproperty 
resolveParagraphStyleClash:ResolveStyleClash

The option for resolving conflicts that arise when paragraph styles have matching names.


Implementation
    public function get resolveParagraphStyleClash():ResolveStyleClash
    public function set resolveParagraphStyleClash(value:ResolveStyleClash):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
Method Detail
addEventListenerWordRTFImportPreference()method
public function addEventListenerWordRTFImportPreference(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
removeEventListenerWordRTFImportPreference()method 
public function removeEventListenerWordRTFImportPreference(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