Adobe InDesign CS5.5 Server (7.5) Object Model JS: HTMLExportPreference

InDesign Server CS5.5

Class

HTMLExportPreference

 HTML export preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Document
Preference
HTMLExportPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
applyImageAlignmentToAnchoredObjectSettingsbool r/wapply image alignment to anchored object settings.
bottomMarginnumber r/wBottom margin of the epub.
bulletExportOptionBulletListExportOption:
BulletListExportOption.UNORDERED_LIST
BulletListExportOption.AS_TEXT
r/wThe bullet export option.
cssExportOptionStyleSheetExportOption:
StyleSheetExportOption.NONE
StyleSheetExportOption.EMBEDDED_CSS
StyleSheetExportOption.STYLE_NAME_ONLY
StyleSheetExportOption.EXTERNAL_CSS
r/wThe cascading style sheet export option.
customImageSizeOptionImageSizeOption:
ImageSizeOption.SIZE_FIXED
ImageSizeOption.SIZE_RELATIVE_TO_PAGE_WIDTH
r/wAllows user to select the image size option for conversion
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
exportOrderExportOrder:
ExportOrder.LAYOUT_ORDER
ExportOrder.ARTICLE_PANEL_ORDER
ExportOrder.XML_STRUCTURE_ORDER
r/wThe export order.
exportSelectionbool r/wIf true and have selection, export selected content to HTML.
externalCSSPathstring r/wThe file path of external cascading style sheet.
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.
ignoreObjectConversionSettingsbool r/wignore object level image conversion settings.
imageAlignmentImageAlignmentType:
ImageAlignmentType.ALIGN_LEFT
ImageAlignmentType.ALIGN_CENTER
ImageAlignmentType.ALIGN_RIGHT
r/wAlignment applied to images
imageConversionImageConversion:
ImageConversion.AUTOMATIC
ImageConversion.JPEG
ImageConversion.GIF
ImageConversion.PNG
r/wThe file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true.
imageExportOptionImageExportOption:
ImageExportOption.ORIGINAL_IMAGE
ImageExportOption.OPTIMIZED_IMAGE
ImageExportOption.LINK_TO_SERVER
r/wThe export order.
imageExportResolutionImageResolution:
ImageResolution.PPI_72
ImageResolution.PPI_96
ImageResolution.PPI_150
ImageResolution.PPI_300
r/wThe export resolution
imageExtensionstring r/wThe image extension on server.
imageSpaceAfternumber (range: 0 - 8640) r/wSpace After applied to images
imageSpaceBeforenumber (range: 0 - 8640) r/wSpace Before applied to images
includeCSSDefinitionbool r/wIf true, include CSS definition.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
javascriptURLstring r/wThe javascript URL.
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.
leftMarginnumber r/wLeft margin of the epub.
levelnumber r/wThe PNG compression level.
linkToJavascriptbool r/wIf true, link to javascript on server.
marginUnitSpaceUnitType:
SpaceUnitType.CSS_EM
SpaceUnitType.CSS_PIXEL
r/wThe unit of margin.
numberedListExportOptionNumberedListExportOption:
NumberedListExportOption.ORDERED_LIST
NumberedListExportOption.STATIC_ORDERED_LIST
NumberedListExportOption.AS_TEXT
r/wThe numbered list export option.
parentDocument readonlyThe parent of the HTMLExportPreference (a Document).
preserveLayoutAppearencebool r/wIf true, format image based on layout appearence.
preserveLocalOverridebool r/wIf true, output local style override.
propertiesObject r/wA property that allows setting of several properties at the same time.
rightMarginnumber r/wRight margin of the epub.
serverPathstring r/wThe server path for image .
spaceUnitSpaceUnitType:
SpaceUnitType.CSS_EM
SpaceUnitType.CSS_PIXEL
r/wThe unit of space.
topMarginnumber r/wTop margin of the epub.
viewDocumentAfterExportbool r/wIf true, open docuemnt in viewer after export.

Methods

Instances

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)

Array of HTMLExportPreference 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 HTMLExportPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Document.htmlExportPreferences

Return

Array of HTMLExportPreference HTMLExportPreference.getElements ()

Jongware, 28-Apr-2012 v3.0.3iContents :: Index