K4 InDesign Javascript API Documentation

PreferencesObjectExportOption

Export options for the object

Extends

Instance Properties

Name Description Access
actualMetadataProperty The metadata property to use as source of actual text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String. read-write
actualTextSourceType SourceType The source type of actual text read-write
altMetadataProperty The metadata property to use as source of alternate text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String. read-write
altTextSourceType SourceType The source type of alternate text read-write
applyTagType TagType The tag type of page item read-write
customActualText string The custom actual text entered by the user read-write
customAltText string The custom alternate text entered by the user read-write
customLayout bool If true, custom layout is enabled for object read-write
customLayoutType CustomLayoutTypeEnum Custom Layout settings to be used for object read-write
customSize string Custom size applied to the object read-write
epubType string The epub type as recommended by IDPF read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
gifOptionsInterlaced bool If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG. read-write
gifOptionsPalette GIFOptionsPalette The color palette for GIF conversion. Note: Not valid when image conversion is JPEG. read-write
imageAlignment ImageAlignmentType Alignment applied to images read-write
imageConversionType ImageFormat Allows user to select the image format for conversion read-write
imageExportResolution ImageResolution The export resolution read-write
imagePageBreak ImagePageBreakType Image page break settings to be used with objects read-write
imageSpaceAfter number Space After applied to images read-write
imageSpaceBefore number Space Before applied to images read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
jpegOptionsFormat JPEGOptionsFormat The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF. read-write
jpegOptionsQuality JPEGOptionsQuality The quality of converted JPEG images. Note: Not valid when image conversion is GIF. read-write
parent The parent of the ObjectExportOption (a ObjectStyle, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, TextFrame or EndnoteTextFrame). read-only
preserveAppearanceFromLayout PreserveAppearanceFromLayoutEnum Preserve Appearance from Layout read-write
properties Object A property that allows setting of several properties at the same time. read-write
sizeType SizeTypeEnum size settings to be used for the object read-write
useImagePageBreak bool If true, image page break settings will be used in objects read-write

Methods

actualText(
)
  → string
addEventListener(
eventType, handler ​[, captures])
  → EventListener
altText(
)
  → string
getElements(
)
  → ObjectExportOption
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
actualText(
)
  → string
Provides the actual text for the object
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
altText(
)
  → string
Provides the alternate text for the object
getElements(
)
  → ObjectExportOption
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the ObjectExportOption.
toSpecifier(
)
  → string
Retrieves the object specifier.