ObjectExportOption

Export options for the object

Go to Property Listing | Method Listing

Methods:

actualText, addEventListener, altText, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, CustomHeightTypeEnum, CustomLayoutTypeEnum, CustomWidthTypeEnum, EventListeners, Events, GIFOptionsPalette, ImageAlignmentType, ImageFormat, ImagePageBreakType, ImageResolution, JPEGOptionsFormat, JPEGOptionsQuality, Number, Object, SourceType, String, TagType,

Hierarchy:

Superclass: Preference

Class: ObjectExportOption

Property Listing

Property	Type	Access	Description
actualMetadataProperty	OrderedarraycontainingnamespacePrefix:String PropertyPath:String	read/write	The metadata property to use as source of actual text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String.
actualTextSourceType	SourceType SourceType.SOURCE_CUSTOM SourceType.SOURCE_XML_STRUCTURE SourceType.SOURCE_XMP_DESCRIPTION SourceType.SOURCE_XMP_HEADLINE SourceType.SOURCE_XMP_OTHER SourceType.SOURCE_XMP_TITLE	read/write	The source type of actual text
altMetadataProperty	OrderedarraycontainingnamespacePrefix:String PropertyPath:String	read/write	The metadata property to use as source of alternate text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String.
altTextSourceType	SourceType SourceType.SOURCE_CUSTOM SourceType.SOURCE_XML_STRUCTURE SourceType.SOURCE_XMP_DESCRIPTION SourceType.SOURCE_XMP_HEADLINE SourceType.SOURCE_XMP_OTHER SourceType.SOURCE_XMP_TITLE	read/write	The source type of alternate text
applyTagType	TagType TagType.TAG_ARTIFACT TagType.TAG_BASED_ON_OBJECT TagType.TAG_FROM_STRUCTURE	read/write	The tag type of page item
customActualText	String	read/write	The custom actual text entered by the user
customAltText	String	read/write	The custom alternate text entered by the user
customHeight	String	read/write	Custom height applied to the object
customHeightType	CustomHeightTypeEnum CustomHeightTypeEnum.CUSTOM_FIXED_HEIGHT CustomHeightTypeEnum.CUSTOM_VALUE_HEIGHT CustomHeightTypeEnum.DEFAULT_HEIGHT CustomHeightTypeEnum.NONE_HEIGHT	read/write	Custom height settings to be used for the object
customImageConversion	Boolean	read/write	If true, custom image conversion is enabled for object
customLayout	Boolean	read/write	If true, custom layout is enabled for object
customLayoutType	CustomLayoutTypeEnum CustomLayoutTypeEnum.ALIGNMENT_AND_SPACING CustomLayoutTypeEnum.FLOAT_LEFT CustomLayoutTypeEnum.FLOAT_RIGHT	read/write	Custom Layout settings to be used for object
customWidth	String	read/write	Custom width applied to the object
customWidthType	CustomWidthTypeEnum CustomWidthTypeEnum.CUSTOM_FIXED_WIDTH CustomWidthTypeEnum.CUSTOM_VALUE_WIDTH CustomWidthTypeEnum.DEFAULT_WIDTH CustomWidthTypeEnum.NONE_WIDTH CustomWidthTypeEnum.RELATIVE_WIDTH	read/write	Custom width settings to be used for the object
epubType	String	read/write	The epub type as recommended by IDPF
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
gifOptionsInterlaced	Boolean	read/write	If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG.
gifOptionsPalette	GIFOptionsPalette GIFOptionsPalette.ADAPTIVE_PALETTE GIFOptionsPalette.MACINTOSH_PALETTE GIFOptionsPalette.WEB_PALETTE GIFOptionsPalette.WINDOWS_PALETTE	read/write	The color palette for GIF conversion. Note: Not valid when image conversion is JPEG.
imageAlignment	ImageAlignmentType ImageAlignmentType.ALIGN_CENTER ImageAlignmentType.ALIGN_LEFT ImageAlignmentType.ALIGN_RIGHT	read/write	Alignment applied to images
imageConversionType	ImageFormat ImageFormat.GIF ImageFormat.JPEG ImageFormat.PNG	read/write	Allows user to select the image format for conversion
imageExportResolution	ImageResolution ImageResolution.PPI_150 ImageResolution.PPI_300 ImageResolution.PPI_72 ImageResolution.PPI_96	read/write	The export resolution
imagePageBreak	ImagePageBreakType ImagePageBreakType.PAGE_BREAK_AFTER ImagePageBreakType.PAGE_BREAK_BEFORE ImagePageBreakType.PAGE_BREAK_BEFORE_AND_AFTER	read/write	Image page break settings to be used with objects
imageSpaceAfter	Number (range 0 - 8640)	read/write	Space After applied to images
imageSpaceBefore	Number (range 0 - 8640)	read/write	Space Before applied to images
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
jpegOptionsFormat	JPEGOptionsFormat JPEGOptionsFormat.BASELINE_ENCODING JPEGOptionsFormat.PROGRESSIVE_ENCODING	read/write	The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF.
jpegOptionsQuality	JPEGOptionsQuality JPEGOptionsQuality.HIGH JPEGOptionsQuality.LOW JPEGOptionsQuality.MAXIMUM JPEGOptionsQuality.MEDIUM	read/write	The quality of converted JPEG images. Note: Not valid when image conversion is GIF.
parent	GraphicLine Group Oval Polygon Rectangle TextFrame ObjectStyle SplineItem	readonly	The parent of the ObjectExportOption (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, TextFrame or ObjectStyle).
properties	Object	read/write	A property that allows setting of several properties at the same time.
useExistingImage	Boolean	read/write	If true, use existing image is enabled for the graphic object
useImagePageBreak	Boolean	read/write	If true, image page break settings will be used in objects

Method Listing

String actualText ()

Provides the actual text for the object

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String altText ()

Provides the alternate text for the object

ObjectExportOption getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the ObjectExportOption.

String toSpecifier ()

Retrieves the object specifier.