Class
Export options for the object Base Class: Preference actualText, addEventListener, altText, getElements, removeEventListener, toSource, toSpecifier
ObjectExportOption
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| actualMetadataProperty | Ordered array containing namespacePrefix:String propertyPath:String |
r/w | 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_XMP_TITLE SourceType.SOURCE_XMP_DESCRIPTION SourceType.SOURCE_XMP_HEADLINE SourceType.SOURCE_XMP_OTHER SourceType.SOURCE_XML_STRUCTURE |
r/w | The source type of actual text |
| altMetadataProperty | Ordered array containing namespacePrefix:String propertyPath:String |
r/w | 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_XMP_TITLE SourceType.SOURCE_XMP_DESCRIPTION SourceType.SOURCE_XMP_HEADLINE SourceType.SOURCE_XMP_OTHER SourceType.SOURCE_XML_STRUCTURE |
r/w | The source type of alternate text |
| applyTagType | TagType: TagType.TAG_FROM_STRUCTURE TagType.TAG_ARTIFACT TagType.TAG_BASED_ON_OBJECT |
r/w | The tag type of page item |
| customActualText | string | r/w | The custom actual text entered by the user |
| customAltText | string | r/w | The custom alternate text entered by the user |
| customImageConversion | bool | r/w | If true, custom image conversion is enabled for object |
| customImageSizeOption | ImageSizeOption: ImageSizeOption.SIZE_FIXED ImageSizeOption.SIZE_RELATIVE_TO_PAGE_WIDTH |
r/w | Allows user to select the image size option for conversion |
| customLayout | bool | r/w | If true, custom layout is enabled for object |
| customLayoutType | CustomLayoutTypeEnum: CustomLayoutTypeEnum.FLOAT_LEFT CustomLayoutTypeEnum.FLOAT_RIGHT CustomLayoutTypeEnum.ALIGNMENT_AND_SPACING |
r/w | Custom Layout settings to be used for object |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| gifOptionsInterlaced | bool | r/w | 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 |
r/w | The color palette for GIF conversion. Note: Not valid when image conversion is JPEG. |
| imageAlignment | ImageAlignmentType: ImageAlignmentType.ALIGN_LEFT ImageAlignmentType.ALIGN_CENTER ImageAlignmentType.ALIGN_RIGHT |
r/w | Alignment applied to images |
| imageConversionType | ImageFormat: ImageFormat.JPEG ImageFormat.GIF ImageFormat.PNG |
r/w | Allows user to select the image format for conversion |
| imageExportResolution | ImageResolution: ImageResolution.PPI_72 ImageResolution.PPI_96 ImageResolution.PPI_150 ImageResolution.PPI_300 |
r/w | The export resolution |
| imagePageBreak | ImagePageBreakType: ImagePageBreakType.PAGE_BREAK_BEFORE ImagePageBreakType.PAGE_BREAK_AFTER ImagePageBreakType.PAGE_BREAK_BEFORE_AND_AFTER |
r/w | Image page break settings to be used with objects |
| imageSpaceAfter | number (range: 0 - 8640) | r/w | Space After applied to images |
| imageSpaceBefore | number (range: 0 - 8640) | r/w | Space Before applied to images |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| jpegOptionsFormat | JPEGOptionsFormat: JPEGOptionsFormat.BASELINE_ENCODING JPEGOptionsFormat.PROGRESSIVE_ENCODING |
r/w | The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF. |
| jpegOptionsQuality | JPEGOptionsQuality: JPEGOptionsQuality.LOW JPEGOptionsQuality.MEDIUM JPEGOptionsQuality.HIGH JPEGOptionsQuality.MAXIMUM |
r/w | The quality of converted JPEG images. Note: Not valid when image conversion is GIF. |
| parent | GraphicLine Group Oval Polygon Rectangle SplineItem TextFrame |
readonly | The parent of the ObjectExportOption (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group or TextFrame). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| useImagePageBreak | bool | r/w | If true, image page break settings will be used in objects |
Methods
Instances
string actualText ()
Provides the actual text for the object
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string altText ()
Provides the alternate text for the object
Array of ObjectExportOption getElements ()
Resolves the object specifier, creating an array of object references.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the ObjectExportOption.
Element of
GraphicLine.objectExportOptions
Group.objectExportOptions
Oval.objectExportOptions
Polygon.objectExportOptions
Rectangle.objectExportOptions
SplineItem.objectExportOptions
TextFrame.objectExportOptions
Return
Array of ObjectExportOption ObjectExportOption.getElements ()
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |