InDesign Server2025
API 20.5.0.49
Object

ObjectExportOption

Export options for the object

Preference ObjectExportOption

Properties

NameType AccessDescription
Array | String read/write The metadata property to use as source of actual text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String.
SourceType
read/write The source type of actual text
Array | String read/write The metadata property to use as source of alternate text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String.
SourceType
read/write The source type of alternate text
TagType
read/write The tag type of page item
String read/write The custom actual text entered by the user
String read/write The custom alternate text entered by the user
Boolean read/write If true, custom layout is enabled for object
CustomLayoutTypeEnum
read/write Custom Layout settings to be used for object
String read/write Custom size applied to the object
String read/write The epub type as recommended by IDPF
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean read/write If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG.
GIFOptionsPalette
read/write The color palette for GIF conversion. Note: Not valid when image conversion is JPEG.
ImageAlignmentType
read/write Alignment applied to images
ImageFormat
read/write Allows user to select the image format for conversion
ImageResolution
read/write The export resolution
ImagePageBreakType
read/write Image page break settings to be used with objects
Number 0–8640 read/write Space After applied to images
Number 0–8640 read/write Space Before applied to images
Boolean readonly Returns true if the object specifier resolves to valid objects.
JPEGOptionsFormat
read/write The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF.
JPEGOptionsQuality
read/write The quality of converted JPEG images. Note: Not valid when image conversion is GIF.
GraphicLine | Group | Oval | Polygon | Rectangle | SplineItem | TextFrame | EndnoteTextFrame | ObjectStyle readonly The parent of the ObjectExportOption (a ObjectStyle, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, TextFrame or EndnoteTextFrame).
PreserveAppearanceFromLayoutEnum
read/write Preserve Appearance from Layout
Object read/write A property that allows setting of several properties at the same time.
SizeTypeEnum
read/write size settings to be used for the object
Boolean read/write If true, image page break settings will be used in objects

Methods

String

Provides the actual text for the object

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

Provides the alternate text for the object

ObjectExportOption[]

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

Boolean

Removes the event listener.

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.
String

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

String

Retrieves the object specifier.

Object of 12

Properties elsewhere that hold a ObjectExportOption.

Return 1

Methods that return a ObjectExportOption.