exportDoc object

The following table lists the properties of the exportDoc object, along with their data types and, where appropriate, acceptable values and notes. All exportDoc properties are read-only.

Note: This object type does not start with a capital letter.

Property (read-only) Data type Notes

altText

string

The alternate text description for the Fireworks document.

backgroundColor

string

The hex color of the document canvas, without the  # character; for example, "FF0000" for red background.

backgroundIsTransparent

Boolean

Set to true if the Fireworks canvas color is transparent or if the export settings specify a transparent GIF format; false otherwise.

backgroundLink

string

The background URL, which is expressed as file://URL.

cssPopupMenus

Boolean

If this value is true, Fireworks will output combined CSS/JavaScript pop-up menus; if false, Fireworks outputs JavaScript-only pop-up menus.

docID

integer

A number that is assigned to a document to help identify HTML generated from it. The docID does not change when you change the name of a file. However, if you use File > Save As, you can get multiple files with the same docID.

docSaveFolder

string

Contains the path of the directory into which the document was last saved. If the document has not yet been saved, this is an empty string.

docSaveName

string

The filename used when the document was saved, without path information, such as "nav.gif".

emptyCellColor

string

A color string that specifies the color of empty table cells (see Color string data type).

emptyCellContents

integer

Specifies what to put into empty cells. Acceptable values are 1 (nothing), 2 (spacer image), and 3 (nonbreaking space).

emptyCellUsesCanvasColor

Boolean

If set to true (the default), empty cells are set to the backgroundColor property. If set to false, they are set to the emptyCellColor property.

externalCSS

Boolean

If set to true, Fireworks will output an external CSS file.

externalCSSFileName

string

The name of the external CSS file.

filename

string

URL for the exported image, relative to the HTML output; for example, "images/Button.gif". In the Slices.htt file, it is the base image name plus the base extension. Unless there is only one slice, the Slices.htt file produces filenames such as "Button_r2_c2.gif".

generateHeader

Boolean

Set to true if an HTML file is generated; false if the output goes to the Clipboard.

hasAltText

Boolean

Set to true if the Fireworks document has an alternate text description.

hasBackgroundLink

Boolean

Set to true if the Fireworks document has a background URL.

height

integer

Height of the image that is being exported, in pixels. In the Slices.htt file, it is the total height of the output images.

htmlEncoding

string

Determines the encoding standard for the HTML file that Fireworks generates during export.

Use "iso-8859-1" for ASCII or "utf-8" for Unicode.

htmlOutputPath

string

File that the HTML is being written to, including the filename, which is expressed as file://URL; for example, "file:///C|/top/nav/navbar.htm".

imagename

string

Name of the image that is being exported, without the extension; for example, "Button".

includeHTMLComments

Boolean

The value of the Include HTML Comments preference, which the export script interprets as appropriate. For example, if this value is false, the Dreamweaver export script removes all nonessential comments.

numFrames

integer

Number of frames that are being exported from the Fireworks document. This value is not zero-based; the value is 1 or more.

pathBase

string

Path of the image that is being exported; for example, "images/Button".

pathSuffix

string

Filename extension of the image that is being exported, including a period; for example, ".gif".

startColumn

integer

Used only in the Metafile.htt file for generating HTML for one slice. Specifies the column of the slice.

startRow

integer

Used only in the Metafile.htt file for generating HTML for one slice. Specifies the row of the slice.

style

string

The HTML style that is used to export the data, such as "Dreamweaver", "Generic", or "FrontPage".

tableAlignment

string

A string that contains the alignment of the table. If the table is left-aligned, the string is simply a space (this is used for writing the HTML table). If the table is center-aligned, the string is "align="center"". If the table is right-aligned, the string is "align="right"".

width

integer

Width of the image being exported, in pixels. In the Slices.htt file, it is the total width of the output images.

xhtmlFormat

Boolean

Determines whether Fireworks outputs XHTML-formatted files (true) or HTML-formatted files (false) when the user exports a file.


 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/fireworks/8/fwextending/fw_02_64.htm