Adobe 65011817 - Fireworks CS4 - Mac, Extended User Manual

Page: 31 / 336

27
Las t up d a ted 12/8/2009
Chapter 3: The Document object
This chapter describes the Fireworks Document object and functions.
Document object properties
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 315.
Property Data type Notes
backgroundColor string A color string that specifies the document canvas color (for
more information, see “
Color string data type ” on page 7).
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 (for more information, see “
Brush object ” on
page 236).
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 the Document-Specific tab of the HTML Setup dialog box.
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 (for more information, see
“
ExportOptions object ” on page 253).
exportSettings object ExportSettings object (for more information, see
“
ExportSettings object ” on page 256).
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
(for more information, see “
Fill object ” on page 258).
frameCount integer The number of frames in the current document.
frameLoopingCount integer –1 — don’t repeat
0 — repeat forever
> 0 — repeat this number of times