Export options for the object
Go to Property Listing | Method Listing
altText, actualText, toSource, getElements, toSpecifier, addEventListener, removeEventListener
Boolean, CustomLayoutTypeEnum, EventListeners, Events, GIFOptionsPalette, GraphicLine, Group, ImageAlignmentType, ImageFormat, ImagePageBreakType, ImageResolution, ImageSizeOption, JPEGOptionsFormat, JPEGOptionsQuality, Number, Object, Oval, Polygon, Rectangle, SourceType, SplineItem, String, TagType, TextFrame,
|
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.SOURCE_CUSTOM SourceType.SOURCE_XMP_TITLE SourceType.SOURCE_XMP_DESCRIPTION SourceType.SOURCE_XMP_HEADLINE SourceType.SOURCE_XMP_OTHER SourceType.SOURCE_XML_STRUCTURE |
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.SOURCE_CUSTOM SourceType.SOURCE_XMP_TITLE SourceType.SOURCE_XMP_DESCRIPTION SourceType.SOURCE_XMP_HEADLINE SourceType.SOURCE_XMP_OTHER SourceType.SOURCE_XML_STRUCTURE |
read/write |
The source type of alternate text |
|
applyTagType |
TagType.TAG_FROM_STRUCTURE TagType.TAG_ARTIFACT TagType.TAG_BASED_ON_OBJECT |
read/write |
The tag type of page item |
|
customActualText |
read/write |
The custom actual text entered by the user |
|
|
customAltText |
read/write |
The custom alternate text entered by the user |
|
|
customImageConversion |
read/write |
If true, custom image conversion is enabled for object |
|
|
customImageSizeOption |
ImageSizeOption.SIZE_FIXED ImageSizeOption.SIZE_RELATIVE_TO_PAGE_WIDTH |
read/write |
Allows user to select the image size option for conversion |
|
customLayout |
read/write |
If true, custom layout is enabled for object |
|
|
customLayoutType |
CustomLayoutTypeEnum.FLOAT_LEFT CustomLayoutTypeEnum.FLOAT_RIGHT CustomLayoutTypeEnum.ALIGNMENT_AND_SPACING |
read/write |
Custom Layout settings to be used for object |
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
gifOptionsInterlaced |
read/write |
If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG. |
|
|
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.ALIGN_LEFT ImageAlignmentType.ALIGN_CENTER ImageAlignmentType.ALIGN_RIGHT |
read/write |
Alignment applied to images |
|
imageConversionType |
ImageFormat.JPEG ImageFormat.GIF ImageFormat.PNG |
read/write |
Allows user to select the image format for conversion |
|
imageExportResolution |
ImageResolution.PPI_72 ImageResolution.PPI_96 ImageResolution.PPI_150 ImageResolution.PPI_300 |
read/write |
The export resolution |
|
imagePageBreak |
ImagePageBreakType.PAGE_BREAK_BEFORE ImagePageBreakType.PAGE_BREAK_AFTER 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 |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
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.LOW JPEGOptionsQuality.MEDIUM JPEGOptionsQuality.HIGH JPEGOptionsQuality.MAXIMUM |
read/write |
The quality of converted JPEG images. Note: Not valid when image conversion is GIF. |
|
parent |
readonly |
The parent of the ObjectExportOption (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group or TextFrame). |
|
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
|
|
useImagePageBreak |
read/write |
If true, image page break settings will be used in objects |
String actualText ()
Provides the actual text for the object
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
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, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
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.