Packagecom.adobe.indesign
Classpublic class ObjectExportOption
InheritanceObjectExportOption Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5.5

Preference



Public Properties
 PropertyDefined By
  actualMetadataProperty : Object
The metadata property to use as source of actual text.
ObjectExportOption
  actualTextSourceType : SourceType
The source type of actual text
ObjectExportOption
  altMetadataProperty : Object
The metadata property to use as source of alternate text.
ObjectExportOption
  altTextSourceType : SourceType
The source type of alternate text
ObjectExportOption
  applyTagType : TagType
The tag type of page item
ObjectExportOption
  customActualText : String
The custom actual text entered by the user
ObjectExportOption
  customAltText : String
The custom alternate text entered by the user
ObjectExportOption
  customImageAlignment : Boolean
If true, custom image alignment is enabled for object
ObjectExportOption
  customImageConversion : Boolean
If true, custom image conversion is enabled for object
ObjectExportOption
  customImageSizeOption : ImageSizeOption
Allows user to select the image size option for conversion
ObjectExportOption
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
ObjectExportOption
  events : Events
[override] [read-only] A collection of events.
ObjectExportOption
  gifOptionsInterlaced : Boolean
If true, generates interlaced GIFs.
ObjectExportOption
  gifOptionsPalette : GIFOptionsPalette
The color palette for GIF conversion.
ObjectExportOption
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  imageAlignment : ImageAlignmentType
Alignment applied to images
ObjectExportOption
  imageConversionType : ImageFormat
Allows user to select the image format for conversion
ObjectExportOption
  imageExportResolution : ImageResolution
The export resolution
ObjectExportOption
  imagePageBreak : ImagePageBreakType
Image page break settings to be used with objects
ObjectExportOption
  imageSpaceAfter : Number
Space After applied to images
ObjectExportOption
  imageSpaceBefore : Number
Space Before applied to images
ObjectExportOption
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
ObjectExportOption
  jpegOptionsFormat : JPEGOptionsFormat
The formatting method for converted JPEG images.
ObjectExportOption
  jpegOptionsQuality : JPEGOptionsQuality
The quality of converted JPEG images.
ObjectExportOption
  parent : Object
[override] [read-only] The parent of the ObjectExportOption (a SplineItem, Polygon, GraphicLine, Rectangle, Oval or Group).
ObjectExportOption
  properties : Object
[override] A property that allows setting of several properties at the same time.
ObjectExportOption
  spaceUnit : SpaceUnitType
The unit of space.
ObjectExportOption
  useImagePageBreak : Boolean
If true, image page break settings will be used in objects
ObjectExportOption
Public Methods
 MethodDefined By
  
actualText():String
Provides the actual text for the object
ObjectExportOption
  
addEventListenerObjectExportOption(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
ObjectExportOption
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
altText():String
Provides the alternate text for the object
ObjectExportOption
 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.
ObjectExportOption
 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
  
removeEventListenerObjectExportOption(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
ObjectExportOption
 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.
ObjectExportOption
 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
actualMetadataPropertyproperty
actualMetadataProperty:Object

Since : CS5.5

The metadata property to use as source of actual text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String.


Implementation
    public function get actualMetadataProperty():Object
    public function set actualMetadataProperty(value:Object):void
actualTextSourceTypeproperty 
actualTextSourceType:SourceType

Since : CS5.5

The source type of actual text


Implementation
    public function get actualTextSourceType():SourceType
    public function set actualTextSourceType(value:SourceType):void
altMetadataPropertyproperty 
altMetadataProperty:Object

Since : CS5.5

The metadata property to use as source of alternate text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String.


Implementation
    public function get altMetadataProperty():Object
    public function set altMetadataProperty(value:Object):void
altTextSourceTypeproperty 
altTextSourceType:SourceType

Since : CS5.5

The source type of alternate text


Implementation
    public function get altTextSourceType():SourceType
    public function set altTextSourceType(value:SourceType):void
applyTagTypeproperty 
applyTagType:TagType

Since : CS5.5

The tag type of page item


Implementation
    public function get applyTagType():TagType
    public function set applyTagType(value:TagType):void
customActualTextproperty 
customActualText:String

Since : CS5.5

The custom actual text entered by the user


Implementation
    public function get customActualText():String
    public function set customActualText(value:String):void
customAltTextproperty 
customAltText:String

Since : CS5.5

The custom alternate text entered by the user


Implementation
    public function get customAltText():String
    public function set customAltText(value:String):void
customImageAlignmentproperty 
customImageAlignment:Boolean

Since : CS5.5

If true, custom image alignment is enabled for object


Implementation
    public function get customImageAlignment():Boolean
    public function set customImageAlignment(value:Boolean):void
customImageConversionproperty 
customImageConversion:Boolean

Since : CS5.5

If true, custom image conversion is enabled for object


Implementation
    public function get customImageConversion():Boolean
    public function set customImageConversion(value:Boolean):void
customImageSizeOptionproperty 
customImageSizeOption:ImageSizeOption

Since : CS5.5

Allows user to select the image size option for conversion


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

Since : CS5.5

A collection of event listeners.


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

Since : CS5.5

A collection of events.


Implementation
    public function get events():Events
gifOptionsInterlacedproperty 
gifOptionsInterlaced:Boolean

Since : CS5.5

If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG.


Implementation
    public function get gifOptionsInterlaced():Boolean
    public function set gifOptionsInterlaced(value:Boolean):void
gifOptionsPaletteproperty 
gifOptionsPalette:GIFOptionsPalette

Since : CS5.5

The color palette for GIF conversion. Note: Not valid when image conversion is JPEG.


Implementation
    public function get gifOptionsPalette():GIFOptionsPalette
    public function set gifOptionsPalette(value:GIFOptionsPalette):void
imageAlignmentproperty 
imageAlignment:ImageAlignmentType

Since : CS5.5

Alignment applied to images


Implementation
    public function get imageAlignment():ImageAlignmentType
    public function set imageAlignment(value:ImageAlignmentType):void
imageConversionTypeproperty 
imageConversionType:ImageFormat

Since : CS5.5

Allows user to select the image format for conversion


Implementation
    public function get imageConversionType():ImageFormat
    public function set imageConversionType(value:ImageFormat):void
imageExportResolutionproperty 
imageExportResolution:ImageResolution

Since : CS5.5

The export resolution


Implementation
    public function get imageExportResolution():ImageResolution
    public function set imageExportResolution(value:ImageResolution):void
imagePageBreakproperty 
imagePageBreak:ImagePageBreakType

Since : CS5.5

Image page break settings to be used with objects


Implementation
    public function get imagePageBreak():ImagePageBreakType
    public function set imagePageBreak(value:ImagePageBreakType):void
imageSpaceAfterproperty 
imageSpaceAfter:Number

Since : CS5.5

Space After applied to images


Implementation
    public function get imageSpaceAfter():Number
    public function set imageSpaceAfter(value:Number):void
imageSpaceBeforeproperty 
imageSpaceBefore:Number

Since : CS5.5

Space Before applied to images


Implementation
    public function get imageSpaceBefore():Number
    public function set imageSpaceBefore(value:Number):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Since : CS5.5

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
jpegOptionsFormatproperty 
jpegOptionsFormat:JPEGOptionsFormat

Since : CS5.5

The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF.


Implementation
    public function get jpegOptionsFormat():JPEGOptionsFormat
    public function set jpegOptionsFormat(value:JPEGOptionsFormat):void
jpegOptionsQualityproperty 
jpegOptionsQuality:JPEGOptionsQuality

Since : CS5.5

The quality of converted JPEG images. Note: Not valid when image conversion is GIF.


Implementation
    public function get jpegOptionsQuality():JPEGOptionsQuality
    public function set jpegOptionsQuality(value:JPEGOptionsQuality):void
parentproperty 
parent:Object  [read-only] [override]

Since : CS5.5

The parent of the ObjectExportOption (a SplineItem, Polygon, GraphicLine, Rectangle, Oval or Group).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object[override]

Since : CS5.5

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
spaceUnitproperty 
spaceUnit:SpaceUnitType

Since : CS5.5

The unit of space.


Implementation
    public function get spaceUnit():SpaceUnitType
    public function set spaceUnit(value:SpaceUnitType):void
useImagePageBreakproperty 
useImagePageBreak:Boolean

Since : CS5.5

If true, image page break settings will be used in objects


Implementation
    public function get useImagePageBreak():Boolean
    public function set useImagePageBreak(value:Boolean):void
Method Detail
actualText()method
public function actualText():String

Since : CS5.5

Provides the actual text for the object

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

Since : CS5.5

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
altText()method 
public function altText():String

Since : CS5.5

Provides the alternate text for the object

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

Since : CS5.5

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

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

Since : CS5.5

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

Since : CS5.5

Retrieves the object specifier.

Returns
String