HTMLExportPreference

HTML export preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, BulletListExportOption, EventListeners, Events, ExportOrder, GIFOptionsPalette, ImageAlignmentType, ImageConversion, ImageExportOption, ImageResolution, ImageSizeOption, JPEGOptionsFormat, JPEGOptionsQuality, Number, NumberedListExportOption, Object, String

Hierarchy:

Superclass: Preference

Class: HTMLExportPreference

Property Listing

Property

Type

Access

Description

bulletExportOption

BulletListExportOption

BulletListExportOption.AS_TEXT

BulletListExportOption.UNORDERED_LIST

read/write

The bullet export option.

customImageSizeOption

ImageSizeOption

ImageSizeOption.SIZE_FIXED

ImageSizeOption.SIZE_RELATIVE_TO_TEXT_FLOW

read/write

Allows user to select the image size option for conversion

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

exportOrder

ExportOrder

ExportOrder.ARTICLE_PANEL_ORDER

ExportOrder.LAYOUT_ORDER

ExportOrder.XML_STRUCTURE_ORDER

read/write

The export order.

exportSelection

Boolean

read/write

If true and have selection, export selected content to HTML.

externalStyleSheets

Array of String

read/write

The file path of external cascading style sheets.

generateCascadeStyleSheet

Boolean

read/write

If true, InDesign will generate cascade style sheet.

gifOptionsInterlaced

Boolean

read/write

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

read/write

The color palette for GIF conversion. Note: Not valid when image conversion is JPEG.

ignoreObjectConversionSettings

Boolean

read/write

ignore object level image conversion settings.

imageAlignment

ImageAlignmentType

ImageAlignmentType.ALIGN_CENTER

ImageAlignmentType.ALIGN_LEFT

ImageAlignmentType.ALIGN_RIGHT

read/write

Alignment applied to images

imageConversion

ImageConversion

ImageConversion.AUTOMATIC

ImageConversion.GIF

ImageConversion.JPEG

ImageConversion.PNG

read/write

The file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true.

imageExportOption

ImageExportOption

ImageExportOption.LINK_TO_SERVER

ImageExportOption.OPTIMIZED_IMAGE

ImageExportOption.ORIGINAL_IMAGE

read/write

The export order.

imageExportResolution

ImageResolution

ImageResolution.PPI_150

ImageResolution.PPI_300

ImageResolution.PPI_72

ImageResolution.PPI_96

read/write

The export resolution

imageExtension

String

read/write

The image extension on server.

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

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

javascripts

Array of String

read/write

The file path of external javascripts.

jpegOptionsFormat

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

JPEGOptionsQuality.HIGH

JPEGOptionsQuality.LOW

JPEGOptionsQuality.MAXIMUM

JPEGOptionsQuality.MEDIUM

read/write

The quality of converted JPEG images. Note: Not valid when image conversion is GIF.

level

Number

read/write

The PNG compression level.

numberedListExportOption

NumberedListExportOption

NumberedListExportOption.AS_TEXT

NumberedListExportOption.ORDERED_LIST

read/write

The numbered list export option.

parent

Document

readonly

The parent of the HTMLExportPreference (a Document).

preserveLayoutAppearence

Boolean

read/write

If true, format image based on layout appearence.

preserveLocalOverride

Boolean

read/write

If true, output local style override.

properties

Object

read/write

A property that allows setting of several properties at the same time.

serverPath

String

read/write

The server path for image .

viewDocumentAfterExport

Boolean

read/write

If true, open docuemnt in viewer after export.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

HTMLExportPreference getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Document.htmlExportPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

HTMLExportPreference.getElements()