User Guide

Core objects 13
Document object
The following table lists the properties of the Document object, along with their data types,
acceptable values and notes. Read-only properties are marked with a bullet (•). You can also use
many API calls to work with documents. For more information, see “Document functions”
on page 104.
Property Data type Notes
backgroundColor
string A color string that specifies the document
canvas color (see “Color string data type”
on page 11).
backgroundURL
string Sets a general URL for a document that uses
a Hotspot. Everything that is not covered by
the Hotspot has the background URL.
brushes •
array Array of Brush objects that are available for
use in the document (see “Brush object”
on page 26).
currentFrameNum
zero-based index The index of the current frame.
currentLayerNum
zero-based index The index of the current layer.
defaultAltText
string Default Alt text for the output images. It
works for single and sliced images. Sliced
images get the default, unless specific text is
specified for a slice. Corresponds to the text
that is specified in File > HTML Properties >
ImageMap > AltImageDescription.
docTitleWithoutExtension
string The title of the document file, without any file
extension. If the document has not been
saved, this string is empty.
exportFormatOptions
object Identical to exportOptions. Included for
backward compatibility with Fireworks 2.
exportOptions
object ExportOptions object (see “ExportOptions
object” on page 46).
exportSettings
object ExportSettings object (see “ExportSettings
object” on page 49).
filePathForRevert
string The path to the file from which this document
was opened, which is expressed as file://
URL, or
null if created from scratch.
filePathForSave
string The location to which this document was
saved, which is expressed as file://URL, or
null if never saved.
fills •
array Array of Fill objects that are available for use
in the document (see “Fill object”
on page 51).
frameCount
integer The number of frames in the
current document.