Adobe 65011817 Extended User Guide - Page 31

Last updated 12/8/2009 27 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 backgroundColor backgroundURL brushes • currentFrameNum currentLayerNum defaultAltText Data type string string array zero-based index zero-based index string docTitleWithoutExtension exportFormatOptions exportOptions exportSettings filePathForRevert filePathForSave fills • frameCount frameLoopingCount string object object object string string array integer integer Notes A color string that specifies the document canvas color (for more information, see "Color string data type" on page 7). Sets a general URL for a document that uses a hotspot. Everything that is not covered by the hotspot has the background URL. Array of Brush objects that are available for use in the document (for more information, see "Brush object" on page 236). The index of the current frame. The index of the current layer. 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. The title of the document file, without any file extension. If the document has not been saved, this string is empty. Identical to exportOptions. Included for backward compatibility with Fireworks 2. ExportOptions object (for more information, see "ExportOptions object" on page 253). ExportSettings object (for more information, see "ExportSettings object" on page 256). The path to the file from which this document was opened, which is expressed as file://URL, or null if created from scratch. The location to which this document was saved, which is expressed as file://URL, or null if never saved. Array of Fill objects that are available for use in the document (for more information, see "Fill object" on page 258). The number of frames in the current document. -1 - don't repeat 0 - repeat forever > 0 - repeat this number of times