Packagecom.adobe.indesign
Classpublic class HTMLExportPreference
InheritanceHTMLExportPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5.5

Preference



Public Properties
 PropertyDefined By
  applyImageAlignmentToAnchoredObjectSettings : Boolean
apply image alignment to anchored object settings.
HTMLExportPreference
  bottomMargin : Number
Bottom margin of the epub.
HTMLExportPreference
  bulletExportOption : BulletListExportOption
The bullet export option.
HTMLExportPreference
  cssExportOption : StyleSheetExportOption
The cascading style sheet export option.
HTMLExportPreference
  customImageSizeOption : ImageSizeOption
Allows user to select the image size option for conversion
HTMLExportPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
HTMLExportPreference
  events : Events
[override] [read-only] A collection of events.
HTMLExportPreference
  exportOrder : ExportOrder
The export order.
HTMLExportPreference
  exportSelection : Boolean
If true and have selection, export selected content to HTML.
HTMLExportPreference
  externalCSSPath : String
The file path of external cascading style sheet.
HTMLExportPreference
  gifOptionsInterlaced : Boolean
If true, generates interlaced GIFs.
HTMLExportPreference
  gifOptionsPalette : GIFOptionsPalette
The color palette for GIF conversion.
HTMLExportPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  ignoreObjectConversionSettings : Boolean
ignore object level image conversion settings.
HTMLExportPreference
  imageAlignment : ImageAlignmentType
Alignment applied to images
HTMLExportPreference
  imageConversion : ImageConversion
The file format to use for converted images.
HTMLExportPreference
  imageExportOption : ImageExportOption
The export order.
HTMLExportPreference
  imageExportResolution : ImageResolution
The export resolution
HTMLExportPreference
  imageExtension : String
The image extension on server.
HTMLExportPreference
  imageSpaceAfter : Number
Space After applied to images
HTMLExportPreference
  imageSpaceBefore : Number
Space Before applied to images
HTMLExportPreference
  includeCSSDefinition : Boolean
If true, include CSS definition.
HTMLExportPreference
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
HTMLExportPreference
  javascriptURL : String
The javascript URL.
HTMLExportPreference
  jpegOptionsFormat : JPEGOptionsFormat
The formatting method for converted JPEG images.
HTMLExportPreference
  jpegOptionsQuality : JPEGOptionsQuality
The quality of converted JPEG images.
HTMLExportPreference
  leftMargin : Number
Left margin of the epub.
HTMLExportPreference
  level : Number
The PNG compression level.
HTMLExportPreference
  linkToJavascript : Boolean
If true, link to javascript on server.
HTMLExportPreference
  marginUnit : SpaceUnitType
The unit of margin.
HTMLExportPreference
  numberedListExportOption : NumberedListExportOption
The numbered list export option.
HTMLExportPreference
  parent : Object
[override] [read-only] The parent of the HTMLExportPreference (a Document).
HTMLExportPreference
  preserveLayoutAppearence : Boolean
If true, format image based on layout appearence.
HTMLExportPreference
  preserveLocalOverride : Boolean
If true, output local style override.
HTMLExportPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
HTMLExportPreference
  rightMargin : Number
Right margin of the epub.
HTMLExportPreference
  serverPath : String
The server path for image .
HTMLExportPreference
  spaceUnit : SpaceUnitType
The unit of space.
HTMLExportPreference
  topMargin : Number
Top margin of the epub.
HTMLExportPreference
  viewDocumentAfterExport : Boolean
If true, open docuemnt in viewer after export.
HTMLExportPreference
Public Methods
 MethodDefined By
  
addEventListenerHTMLExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
HTMLExportPreference
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
HTMLExportPreference
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
removeEventListenerHTMLExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
HTMLExportPreference
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
HTMLExportPreference
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
applyImageAlignmentToAnchoredObjectSettingsproperty
applyImageAlignmentToAnchoredObjectSettings:Boolean

Since : CS5.5

apply image alignment to anchored object settings.


Implementation
    public function get applyImageAlignmentToAnchoredObjectSettings():Boolean
    public function set applyImageAlignmentToAnchoredObjectSettings(value:Boolean):void
bottomMarginproperty 
bottomMargin:Number

Since : CS5.5

Bottom margin of the epub.


Implementation
    public function get bottomMargin():Number
    public function set bottomMargin(value:Number):void
bulletExportOptionproperty 
bulletExportOption:BulletListExportOption

Since : CS5.5

The bullet export option.


Implementation
    public function get bulletExportOption():BulletListExportOption
    public function set bulletExportOption(value:BulletListExportOption):void
cssExportOptionproperty 
cssExportOption:StyleSheetExportOption

Since : CS5.5

The cascading style sheet export option.


Implementation
    public function get cssExportOption():StyleSheetExportOption
    public function set cssExportOption(value:StyleSheetExportOption):void
customImageSizeOptionproperty 
customImageSizeOption:ImageSizeOption

Since : CS5.5

Allows user to select the image size option for conversion


Implementation
    public function get customImageSizeOption():ImageSizeOption
    public function set customImageSizeOption(value:ImageSizeOption):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

Since : CS5.5

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

Since : CS5.5

A collection of events.


Implementation
    public function get events():Events
exportOrderproperty 
exportOrder:ExportOrder

Since : CS5.5

The export order.


Implementation
    public function get exportOrder():ExportOrder
    public function set exportOrder(value:ExportOrder):void
exportSelectionproperty 
exportSelection:Boolean

Since : CS5.5

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


Implementation
    public function get exportSelection():Boolean
    public function set exportSelection(value:Boolean):void
externalCSSPathproperty 
externalCSSPath:String

Since : CS5.5

The file path of external cascading style sheet.


Implementation
    public function get externalCSSPath():String
    public function set externalCSSPath(value:String):void
gifOptionsInterlacedproperty 
gifOptionsInterlaced:Boolean

Since : CS5.5

If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG.


Implementation
    public function get gifOptionsInterlaced():Boolean
    public function set gifOptionsInterlaced(value:Boolean):void
gifOptionsPaletteproperty 
gifOptionsPalette:GIFOptionsPalette

Since : CS5.5

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


Implementation
    public function get gifOptionsPalette():GIFOptionsPalette
    public function set gifOptionsPalette(value:GIFOptionsPalette):void
ignoreObjectConversionSettingsproperty 
ignoreObjectConversionSettings:Boolean

Since : CS5.5

ignore object level image conversion settings.


Implementation
    public function get ignoreObjectConversionSettings():Boolean
    public function set ignoreObjectConversionSettings(value:Boolean):void
imageAlignmentproperty 
imageAlignment:ImageAlignmentType

Since : CS5.5

Alignment applied to images


Implementation
    public function get imageAlignment():ImageAlignmentType
    public function set imageAlignment(value:ImageAlignmentType):void
imageConversionproperty 
imageConversion:ImageConversion

Since : CS5.5

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


Implementation
    public function get imageConversion():ImageConversion
    public function set imageConversion(value:ImageConversion):void
imageExportOptionproperty 
imageExportOption:ImageExportOption

Since : CS5.5

The export order.


Implementation
    public function get imageExportOption():ImageExportOption
    public function set imageExportOption(value:ImageExportOption):void
imageExportResolutionproperty 
imageExportResolution:ImageResolution

Since : CS5.5

The export resolution


Implementation
    public function get imageExportResolution():ImageResolution
    public function set imageExportResolution(value:ImageResolution):void
imageExtensionproperty 
imageExtension:String

Since : CS5.5

The image extension on server.


Implementation
    public function get imageExtension():String
    public function set imageExtension(value:String):void
imageSpaceAfterproperty 
imageSpaceAfter:Number

Since : CS5.5

Space After applied to images


Implementation
    public function get imageSpaceAfter():Number
    public function set imageSpaceAfter(value:Number):void
imageSpaceBeforeproperty 
imageSpaceBefore:Number

Since : CS5.5

Space Before applied to images


Implementation
    public function get imageSpaceBefore():Number
    public function set imageSpaceBefore(value:Number):void
includeCSSDefinitionproperty 
includeCSSDefinition:Boolean

Since : CS5.5

If true, include CSS definition.


Implementation
    public function get includeCSSDefinition():Boolean
    public function set includeCSSDefinition(value:Boolean):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Since : CS5.5

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
javascriptURLproperty 
javascriptURL:String

Since : CS5.5

The javascript URL.


Implementation
    public function get javascriptURL():String
    public function set javascriptURL(value:String):void
jpegOptionsFormatproperty 
jpegOptionsFormat:JPEGOptionsFormat

Since : CS5.5

The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF.


Implementation
    public function get jpegOptionsFormat():JPEGOptionsFormat
    public function set jpegOptionsFormat(value:JPEGOptionsFormat):void
jpegOptionsQualityproperty 
jpegOptionsQuality:JPEGOptionsQuality

Since : CS5.5

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


Implementation
    public function get jpegOptionsQuality():JPEGOptionsQuality
    public function set jpegOptionsQuality(value:JPEGOptionsQuality):void
leftMarginproperty 
leftMargin:Number

Since : CS5.5

Left margin of the epub.


Implementation
    public function get leftMargin():Number
    public function set leftMargin(value:Number):void
levelproperty 
level:Number

Since : CS5.5

The PNG compression level.


Implementation
    public function get level():Number
    public function set level(value:Number):void
linkToJavascriptproperty 
linkToJavascript:Boolean

Since : CS5.5

If true, link to javascript on server.


Implementation
    public function get linkToJavascript():Boolean
    public function set linkToJavascript(value:Boolean):void
marginUnitproperty 
marginUnit:SpaceUnitType

Since : CS5.5

The unit of margin.


Implementation
    public function get marginUnit():SpaceUnitType
    public function set marginUnit(value:SpaceUnitType):void
numberedListExportOptionproperty 
numberedListExportOption:NumberedListExportOption

Since : CS5.5

The numbered list export option.


Implementation
    public function get numberedListExportOption():NumberedListExportOption
    public function set numberedListExportOption(value:NumberedListExportOption):void
parentproperty 
parent:Object  [read-only] [override]

Since : CS5.5

The parent of the HTMLExportPreference (a Document).


Implementation
    public function get parent():Object
preserveLayoutAppearenceproperty 
preserveLayoutAppearence:Boolean

Since : CS5.5

If true, format image based on layout appearence.


Implementation
    public function get preserveLayoutAppearence():Boolean
    public function set preserveLayoutAppearence(value:Boolean):void
preserveLocalOverrideproperty 
preserveLocalOverride:Boolean

Since : CS5.5

If true, output local style override.


Implementation
    public function get preserveLocalOverride():Boolean
    public function set preserveLocalOverride(value:Boolean):void
propertiesproperty 
properties:Object[override]

Since : CS5.5

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


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
rightMarginproperty 
rightMargin:Number

Since : CS5.5

Right margin of the epub.


Implementation
    public function get rightMargin():Number
    public function set rightMargin(value:Number):void
serverPathproperty 
serverPath:String

Since : CS5.5

The server path for image .


Implementation
    public function get serverPath():String
    public function set serverPath(value:String):void
spaceUnitproperty 
spaceUnit:SpaceUnitType

Since : CS5.5

The unit of space.


Implementation
    public function get spaceUnit():SpaceUnitType
    public function set spaceUnit(value:SpaceUnitType):void
topMarginproperty 
topMargin:Number

Since : CS5.5

Top margin of the epub.


Implementation
    public function get topMargin():Number
    public function set topMargin(value:Number):void
viewDocumentAfterExportproperty 
viewDocumentAfterExport:Boolean

Since : CS5.5

If true, open docuemnt in viewer after export.


Implementation
    public function get viewDocumentAfterExport():Boolean
    public function set viewDocumentAfterExport(value:Boolean):void
Method Detail
addEventListenerHTMLExportPreference()method
public function addEventListenerHTMLExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Since : CS5.5

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
getElements()method 
override public function getElements():Object

Since : CS5.5

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

Returns
Object
removeEventListenerHTMLExportPreference()method 
public function removeEventListenerHTMLExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Since : CS5.5

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Since : CS5.5

Retrieves the object specifier.

Returns
String