Class

ObjectExportOption

 Export options for the object Base Class: Preference

QuickLinks

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

Hierarchy

GraphicLine | Group | Oval | Polygon | Rectangle | SplineItem | TextFrame
Preference
ObjectExportOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
actualMetadataPropertyOrdered array containing namespacePrefix:String
propertyPath:String
r/wThe metadata property to use as source of actual text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String.
actualTextSourceTypeSourceType:
SourceType.SOURCE_CUSTOM
SourceType.SOURCE_XMP_TITLE
SourceType.SOURCE_XMP_DESCRIPTION
SourceType.SOURCE_XMP_HEADLINE
SourceType.SOURCE_XMP_OTHER
SourceType.SOURCE_XML_STRUCTURE
r/wThe source type of actual text
altMetadataPropertyOrdered array containing namespacePrefix:String
propertyPath:String
r/wThe metadata property to use as source of alternate text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String.
altTextSourceTypeSourceType:
SourceType.SOURCE_CUSTOM
SourceType.SOURCE_XMP_TITLE
SourceType.SOURCE_XMP_DESCRIPTION
SourceType.SOURCE_XMP_HEADLINE
SourceType.SOURCE_XMP_OTHER
SourceType.SOURCE_XML_STRUCTURE
r/wThe source type of alternate text
applyTagTypeTagType:
TagType.TAG_FROM_STRUCTURE
TagType.TAG_ARTIFACT
TagType.TAG_BASED_ON_OBJECT
r/wThe tag type of page item
customActualTextstring r/wThe custom actual text entered by the user
customAltTextstring r/wThe custom alternate text entered by the user
customImageConversionbool r/wIf true, custom image conversion is enabled for object
customImageSizeOptionImageSizeOption:
ImageSizeOption.SIZE_FIXED
ImageSizeOption.SIZE_RELATIVE_TO_PAGE_WIDTH
r/wAllows user to select the image size option for conversion
customLayoutbool r/wIf true, custom layout is enabled for object
customLayoutTypeCustomLayoutTypeEnum:
CustomLayoutTypeEnum.FLOAT_LEFT
CustomLayoutTypeEnum.FLOAT_RIGHT
CustomLayoutTypeEnum.ALIGNMENT_AND_SPACING
r/wCustom Layout settings to be used for object
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
gifOptionsInterlacedbool r/wIf true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG.
gifOptionsPaletteGIFOptionsPalette:
GIFOptionsPalette.ADAPTIVE_PALETTE
GIFOptionsPalette.MACINTOSH_PALETTE
GIFOptionsPalette.WEB_PALETTE
GIFOptionsPalette.WINDOWS_PALETTE
r/wThe color palette for GIF conversion. Note: Not valid when image conversion is JPEG.
imageAlignmentImageAlignmentType:
ImageAlignmentType.ALIGN_LEFT
ImageAlignmentType.ALIGN_CENTER
ImageAlignmentType.ALIGN_RIGHT
r/wAlignment applied to images
imageConversionTypeImageFormat:
ImageFormat.JPEG
ImageFormat.GIF
ImageFormat.PNG
r/wAllows user to select the image format for conversion
imageExportResolutionImageResolution:
ImageResolution.PPI_72
ImageResolution.PPI_96
ImageResolution.PPI_150
ImageResolution.PPI_300
r/wThe export resolution
imagePageBreakImagePageBreakType:
ImagePageBreakType.PAGE_BREAK_BEFORE
ImagePageBreakType.PAGE_BREAK_AFTER
ImagePageBreakType.PAGE_BREAK_BEFORE_AND_AFTER
r/wImage page break settings to be used with objects
imageSpaceAfternumber (range: 0 - 8640) r/wSpace After applied to images
imageSpaceBeforenumber (range: 0 - 8640) r/wSpace Before applied to images
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
jpegOptionsFormatJPEGOptionsFormat:
JPEGOptionsFormat.BASELINE_ENCODING
JPEGOptionsFormat.PROGRESSIVE_ENCODING
r/wThe formatting method for converted JPEG images. Note: Not valid when image conversion is GIF.
jpegOptionsQualityJPEGOptionsQuality:
JPEGOptionsQuality.LOW
JPEGOptionsQuality.MEDIUM
JPEGOptionsQuality.HIGH
JPEGOptionsQuality.MAXIMUM
r/wThe quality of converted JPEG images. Note: Not valid when image conversion is GIF.
parentGraphicLine
Group
Oval
Polygon
Rectangle
SplineItem
TextFrame
readonlyThe parent of the ObjectExportOption (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group or TextFrame).
propertiesObject r/wA property that allows setting of several properties at the same time.
useImagePageBreakbool r/wIf 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

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.3hContents :: Index