Chapter 3: The Document Object - Adobe 38039927 - Fireworks CS3 - PC Extended User Manual

Chapter 3: The Document object

This chapter describes the Fireworks Document object and functions.
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 "Property inspector functions" on page 294.
Property
backgroundColor
backgroundURL
brushes •
currentFrameNum
currentLayerNum
defaultAltText
docTitleWithoutExtensio
n
exportFormatOptions
exportOptions
exportSettings
filePathForRevert
filePathForSave
fills •
frameCount
Data type Notes
string A color string that specifies the document canvas
color (for more information, see "Color string data
type" on page 5).
string Sets a general URL for a document that uses a
Hotspot. Everything that is not covered by the
Hotspot has the background URL.
array Array of Brush objects that are available for use in the
document (for more information, see "Brush object"
on page 208).
zero-based index The index of the current frame.
zero-based index The index of the current layer.
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.
string The title of the document file, without any file exten-
sion. If the document has not been saved, this string
is empty.
object Identical to
ward compatibility with Fireworks 2.
object ExportOptions object (for more information, see
"ExportOptions object" on page 227).
object ExportSettings object (for more information, see
"ExportSettings object" on page 230).
string The path to the file from which this document was
opened, which is expressed as file://URL, or
created from scratch.
string The location to which this document was saved,
which is expressed as file://URL, or
saved.
array Array of Fill objects that are available for use in the
document (for more information, see "Fill object" on
page 233).
integer The number of frames in the current document.
. Included for back-
exportOptions
if never
null
null if
20