manualshive.com logo in svg

MACROMEDIA FIREWORKS 8-EXTENDING FIREWORKS, Manual

Share
Download
MACROMEDIA FIREWORKS 8-EXTENDING FIREWORKS Manual Download Page 149

Document functions

149

dom.addSwapImageBehaviorFromPoint()

Availability

Fireworks 3.

Usage

dom.AddSwapImageBehaviorFromPoint(

where

)

Arguments

where

  A point that specifies the 

x,y

 coordinates of the Hotspot or slice that contains the 

swap image behavior to be added (see 

“Point data type” on page 12

).

Returns

true

 if the swap image behavior was added; 

false

 if no suitable Hotspot was at the 

specified location.

Description

If a single Hotspot or slice is selected, this function adds to it a swap image behavior from the 
Hotspot or slice located at 

where

 in the document. 

dom.adjustExportToSize()

Availability

Fireworks 3.

Usage

dom.AdjustExportToSize(

sizeInBytes

, 

bOkToIncreaseSize

)

Arguments

sizeInBytes

  An integer that specifies the size to be used for exporting. It is used as 

described in the following list:

■

If a document has no slices, 

sizeInBytes

 adjusts the export settings for the current frame 

so that the image is less than or equal to 

sizeInBytes

.

■

If a document has slices, 

sizeInBytes

 adjusts the size of all exported images so that the 

sum of the sizes is greater than or equal to 

sizeInBytes

.

Summary of Contents for FIREWORKS 8-EXTENDING FIREWORKS

Page 1: ...Extending Fireworks ...

Page 2: ...nience and the inclusion of the link does not imply that Macromedia endorses or accepts any responsibility for the content on those third party sites Copyright 2005 Macromedia Inc All rights reserved This manual may not be copied photocopied reproduced translated or converted to any electronic or machine readable form in whole or in part without written approval from Macromedia Inc Notwithstanding...

Page 3: ... Fireworks object 26 Objects within Fireworks documents 32 HTML export objects 80 Working with selected objects 92 Chapter 3 Cross Product Extensions 99 Cross product architecture 99 Flash panels 115 Chapter 4 Auto Shapes 123 How Auto Shapes work 123 Creating an Auto Shape 124 Chapter 5 Fireworks JavaScript API 131 Using Fireworks API functions 131 Document functions 132 Fireworks functions 305 Pr...

Page 4: ...4 Contents ...

Page 5: ...the custom JavaScript functions that are built into Fireworks Prerequisites Because Fireworks extensions must be written in JavaScript this guide assumes that readers are familiar with JavaScript syntax and with basic programming concepts such as functions arguments and data types It also assumes that readers understand the concept of working with objects and properties This guide does not attempt...

Page 6: ...e Commands Manage Extensions to start the Extension Manager or you can start Extension Manager located in the Macromedia program group independently from Fireworks 7 In the Extension Manager choose File Install Extension and choose the extension package you just saved The Extension Manager automatically installs the extension into Fireworks You cannot begin using some extensions until you restart ...

Page 7: ...The APIs in this class let you run standard application dialog boxes that are usually accessible only through the menu Get system information The new System class in Fireworks 8 provides APIs that let you query for information about the operating system Conventions used in this guide The following typographical conventions are used in this guide Code font indicates code fragments and API literals ...

Page 8: ...tending Fireworks Overview Additional resources for extension writers To communicate with other developers who are writing extensions you can visit the Fireworks online forums at www macromedia com go 13012 ...

Page 9: ...nformation see The Fireworks object on page 26 Numerous objects associated with Fireworks documents such as ExportOptions Guides Path Image and Text For more information see Objects within Fireworks documents on page 32 A set of objects that you can use to specify the format of HTML code when exporting from Fireworks For more information see HTML export objects on page 80 Using the Fireworks Objec...

Page 10: ...alues For all properties that are not read only you can pass values to change elements of a document For example the following command sets the fifth brush in the third open document to a square shape fw documents 2 brushes 4 shape square The preceding example includes the following properties documents is a property of the Fireworks object and contains an array of Document objects brushes is a pr...

Page 11: ...Fireworks objects but are JavaScript object types that are specific to Fireworks These types of arguments are described next in alphabetical order Color string data type Functions that accept colors as arguments use the HTML syntax rrggbb You can specify a color with an alpha transparency component by passing a longer string of the form rrggbbaa Mask data type The format for a mask is maskBounds r...

Page 12: ...nce dom addNewOval boundingRectangle could look like the following example fw getDocumentDOM addNewOval left 72 top 79 right 236 bottom 228 Resolution data type The format for resolution is pixelsPerUnit float units string Acceptable values for units are inch or cm For instance dom setDocumentResolution resolution could look like the following example fw getDocumentDOM setDocumentResolution pixels...

Page 13: ...TML was created to let you differentiate HTML output calls from other JavaScript calls in your code WRITE_CSS string Available only when exporting Writes the CSS as an external file WRITE_HTML arg1 arg2 argN string Available only when exporting Converts each argument to a string and writes it to the HTML output file To enter an end of line character use n this is converted to the correct line endi...

Page 14: ...ument for more information see Brush object on page 33 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 ...

Page 15: ...nformation see Frame object on page 65 gammaPreview Boolean If set to true the document should be previewed in opposite platform gamma If set to false the document colors are unadjusted gradients array Array of Gradient objects that are available for use in the document for more information see Gradient object on page 66 gridColor string A color string that specifies the color of the grid display ...

Page 16: ... object that is associated with a document lingers after the document closes this property lets you check for that eventuality lastExportDirectory string The path to the last directory to which the file was exported which is expressed as file URL or null if the file was never exported For instance if the document was last exported to file files current logo gif it returns file files current lastEx...

Page 17: ...onionSkinBefore integer Similar to the onionSkinAfter property but refers to the number of frames to show through onion skinning before the current frame patterns object List of internal pattern names pathAttributes object PathAttrs object for more information see PathAttrs object on page 68 This object specifies default attributes that will be applied to all newly created objects pngText object A...

Page 18: ...vailable for use in the document for more information see Texture object on page 56 top integer Coordinate of the top edge of the document in pixels To find the bottom edge of the document use document top document height useMatteColor Boolean If set to true the matteColor property is used when exporting documents with transparent backgrounds If set to false the matteColor property is ignored in t...

Page 19: ...s and where appropriate acceptable values and notes Method Data type Notes copy docname1 docname2 string string Copies the file specified in the first argument to the file specified in the second argument Each argument must be the name of a file which is expressed as file URL Only files not directories can be copied The files do not need to reside on the same drive and the method does not overwrit...

Page 20: ...ay contains a single entry the file passed in exists docOrDir string Returns true if docOrDir refers to a directory or file that exists false otherwise getDirectory docname string Returns only the directory name from docname which is expressed as file URL For example Files getDirectory file work logo png returns file work getExtension docname string Returns the filename extension if any of docname...

Page 21: ...les directory isDirectory dirname string The argument must be expressed as file URL Returns true if the specified URL refers to a directory that exists false otherwise makePathFromDirAndFile dirname plainFilename string string The first argument must be expressed as file URL Concatenates the two arguments to return a file URL that references the specified filename in the specified directory For ex...

Page 22: ...turns a file URL with docname replaced by newPlainFilename For example Files setFilename file work logo png oldlogo png returns file work oldlogo png This method does not affect the file on disk it simply provides a convenient way to manipulate file URLs To change the name on disk use rename swap docname1 docname2 string string Each argument must be expressed as a file URL Swaps the contents of th...

Page 23: ...ne Closes the current File Reference object You are not required to use this method the file is closed when the Files object is destroyed but it is useful for controlling access to a file readline none Reads the next line from the current File Reference object and returns it as a string The end of line character s are not included in the string Returns null if end of file is reached or if the line...

Page 24: ...le to find AnyStyle 1 Plain 0 Bold 1 Italic 2 BoldItalic 3 Underline 4 BoldUnderline 5 ItalicUnderline 6 BoldItalicUnderline 7 replaceStyle integer Number that represents the style to be used as replacement findMinSize integer 0 to 9999 findMaxSize integer 0 to 9999 replaceSize integer 0 to 9999 or pass 1 to leave size as is Property Data type Notes whatToFind string In the format color find strin...

Page 25: ...placement text which is expressed as file URL wholeWord Boolean If set to true only whole words that match the search text are found The default is false matchCase Boolean If set to true the search is case sensitive Defaults to false regExp Boolean If set to true the find and replace text is interpreted as a regular expression The default value is false Property Data type Notes whatToFind string I...

Page 26: ...turns the system color used for the control and panel faces Windows only property controlHighlightColor string Returns the system color used for control highlights Windows only property controlShadowColor string Returns the system color used for control shadows Windows only property controlDarkShadowColor string Returns the system color used for control dark shadows Windows only property highlight...

Page 27: ...tains the Fireworks application which is expressed as file URL appExportSettingsDir string The path to the Export Settings directory which is expressed as file URL In Fireworks this folder is stored on a per user basis on multiuser systems Even on single user systems this folder is not inside the Fireworks installation directory appFavoritesDir string The path to the URL Libraries directory which ...

Page 28: ... installation directory appSettingsDir string The path to the Settings directory which is expressed as file URL appSmartShapesDir string The path to the application s Auto Shapes directory which is expressed as file URL appSmartShapeToolsDir string The path to the application s Auto Shape Tools directory which is expressed as file URL appStylesDir string The path to the Styles directory which is e...

Page 29: ...currently running script or could be null This name is the script s filename not the full path dialogs object Provides access to an instance of the Dialogs class which opens specific dialog boxes for more information see Dialogs object on page 13 dismissBatchDialogWhenDone Boolean If set to true Fireworks will automatically close the Batch Process dialog box when the script finishes This function ...

Page 30: ...StartBackgroundColor color Returns the start color for the background gradient This function is only useful for the Windows platform historyPalette object History panel object There are no DOM properties for the History panel only API calls For more information see History panel functions on page 350 isConnectedToInternet integer Returns whether the operating system is connected to the Internet Th...

Page 31: ...t is open it returns null selectedMask object If a single item is selected and that item is a mask this property returns an ElementMask object for more information see ElementMask object on page 56 otherwise it returns null styles array Array of the Style object that is currently loaded in the Style panel for more information see Style object on page 76 textInsertionIndex integer Insertion index i...

Page 32: ... directory which is expressed as a file URL userSmartShapeToolsDir string The path to the user s Auto Shape Tools directory which is expressed as a file URL userSymbolLibrariesDir string The path to the user s Symbol Libraries which is expressed as file URL userSwfCommandsDir string The path to the user level SWF Commands directory which is expressed as a file URL In Fireworks this folder is store...

Page 33: ...rd value in some situations Property Data type Notes alphaRemap string Acceptable values are none white neon harsh wet smooth neon wavy gravy and white neon edge angle integer 0 to 360 antiAliased Boolean If set to true the brush edges are anti aliased aspect float 0 to 100 blackness float 0 to 100 category string Determines in which subsection of the Stroke panel the brush will appear for example...

Page 34: ...lue and vdir is the vertical value and blackness is the build up of black pixels as some tools brush over the same spot repeatedly like the felt tip sense_hdir_blackness float sense_hdir_hue float sense_hdir_lightness float sense_hdir_opacity float sense_hdir_saturation float sense_hdir_scatter float sense_hdir_size float sense_pressure_angle float sense_pressure_blackness float sense_pressure_hue...

Page 35: ...ess float sense_vdir_hue float sense_vdir_lightness float sense_vdir_opacity float sense_vdir_saturation float sense_vdir_scatter float sense_vdir_size float sensitivity_x_y integer 0 to 100 where x is a value of pressure speed hDir vDir or random and y is a value of size angle opacity blackness scatter hue lightness or saturation For example sensitivity_pressure_size shape string Acceptable value...

Page 36: ...m uniform complementary hue and shadow tipCount integer 1 to 32 tipSpacing float 0 to 100 tipSpacingMode string Acceptable values are random diagonal and circular type string Acceptable values are natural and simple Property Data type Notes isClosed Boolean If set to true the path is closed by connecting the final point in the contour with the first point nodes array Array of ContourNode objects o...

Page 37: ...forces a smooth curve If set to false there are no constraints on the control points isSelectedPoint Boolean If set to true this point was subselected for example by the subselection tool name string A unique name assigned to the object predX float The x coordinate of the contour node s preceding control point predY float The y coordinate of the contour node s preceding control point randomSeed in...

Page 38: ...move parameters Use smartShape GetDefaultMoveParms to obtain this object then adjust properties as needed For a list of properties see RegisterMoveParms object on page 70 RegisterCircularMove point The center point for the circular movement object The RegisterMoveParms object containing the move parameters Use smartShape GetDefaultMoveParms to obtain this object then adjust properties as needed Fo...

Page 39: ... 0 to 1 0 velocity float 0 0 to 255 9999 pixels per millisecond Property Data type Notes hiliteDragOverObject Boolean If true Fireworks highlights an object when a control point is dragged over it index integer Index for the control point name string Assigned name of the control point toolTip string Text to display when the user rolls the pointer mouse over the control point toolTipTracksDrag Bool...

Page 40: ...operties see RegisterMoveParms object on page 70 RegisterCircularMove point The center point for the circular movement object The RegisterMoveParms object containing the move parameters Use smartShape GetDefaultMoveParms to obtain this object then adjust properties as needed For a list of properties see RegisterMoveParms object on page 70 RegisterPolygonMove point The center point for the polygon ...

Page 41: ...s of the bevel BevelContrast integer 0 to 100 percent BevelType integer Sets a bevel as inner outer raised embossed inset embossed or glow effect as follows InnerBevel 0 OuterBevel 1 RaiseEmboss 2 InsetEmboss 3 GlowEffect 4 BevelWidth integer The width of the bevel in pixels ButtonState integer BevelButtonUp 0 BevelButtonOver 1 BevelButtonDown 2 BevelButtonHit 3 DownBlendColor string A color strin...

Page 42: ... although any value should work This is the complement of ShadowColor HitBlendColor string A color string that specifies the color that is blended on the face of the image if ButtonState 3 BevelButtonHit for more information see Color string data type on page 11 LightAngle integer The light angle in degrees that is used to create the light and shadow effects for the bevel MaskSoftness integer The ...

Page 43: ... type Notes EffectMoaID string f1cfce41 718e 11d1 8c8200a024cdc039 EffectIsVisible Boolean If set to false the effect is included but temporarily hidden The default value is true Property Data type Notes EffectIsVisible Boolean If set to false the effect is included but temporarily hidden The default value is true EffectMoaID string f1cfce42 718e 11d1 8c8200a024cdc039 Property Data type Notes brig...

Page 44: ... input level and y output level All x and y values must be between 0 and 255 and the points must be sorted in ascending order of the points x coordinate values red_points green_points blue_points Property Data type Notes EffectIsVisible Boolean If set to false the effect is included but temporarily hidden The default value is true EffectMoaID string a7944db8 6ce2 11d1 8c76000502701850 ShadowAngle ...

Page 45: ...alue is true EffectMoaID string d04ef8c0 71b3 11d1 8c8200a024cdc039 gaussian_blur_radius float 0 1 to 250 Property Data type Notes EffectIsVisible Boolean If set to false the effect is included but temporarily hidden The default value is true EffectMoaID string 3439b08d 1922 11d3 9bde00e02910d580 hue_amount integer 180 to 180 if hls_colorize is false 0 to 360 if hls_colorize is true saturation_amo...

Page 46: ...ring A color string that specifies the color of the shadow for more information see Color string data type on page 11 ShadowDistance integer The offset of the shadow in pixels ShadowType integer 0 normal shadow 1 knockout shadow Property Data type Notes EffectMoaID string d2541291 70d6 11d1 8c8000a024cdc039 EffectIsVisible Boolean If set to false the effect is included but temporarily hidden The d...

Page 47: ...s are all output levels to the filter with values of 0 to 255 dest_high_rgb dest_low_red dest_high_red dest_low_green dest_high_green dest_low_blue dest_high_blue gamma_rgb float These gamma values are all gamma levels to the filter with values of 0 1 to 10 0 gamma_red gamma_green gamma_blue Property Data type Notes EffectMoaID string c20952b1 fc76 11d0 8be700a024cdc039 EffectIsVisible Boolean If ...

Page 48: ...orarily hidden The default value is true Property Data type Notes EffectMoaID string f1cfce44 718e 11d1 8c8200a024cdc039 EffectIsVisible Boolean If set to false the effect is included but temporarily hidden The default value is true unsharp_mask_amount integer 1 to 500 unsharp_mask_radius float 0 1 to 250 unsharp_mask_threshold integer 0 to 255 Property Data type Notes category string Specifies wh...

Page 49: ...I calls are used to resize specific types of elements isSmartShape Boolean Confirms whether the element is an Auto Shape left float Can round to an integer mask object ElementMask object for more information see ElementMask object on page 56 Returns null if the element has no element mask name string Can be null removes any existing name opacity float Acceptable values 0 to 100 represent percent o...

Page 50: ...h float Read only in the base class other properties or API calls are used to resize specific types of elements Method Parameter Definition generateSmartShapeCode root The root parameter is a string value that is prefixed to each line of output Property Data type Notes controlPoints array Array of control points defined for the Auto Shape object elements array Array of Element objects in the group...

Page 51: ...odified Method Parameter Definition generateSmartShapeCode string Generates JavaScript code for creating an Auto Shape You can specify a string to prefix each line of output globalToSmartShapeCoords point Changes an object to the new coordinates after an Auto Shape is transformed scaled skewed or rotated so that the Auto Shape object contains the new location RegisterForEvent string Call this to r...

Page 52: ...rked with a bullet unRegisterAllEvents none Call this to stop receiving notification of all previously registered events UnRegisterForEvent string Call this to stop receiving notification of a single previously registered event Property Data type Notes altText string The alternate text description instanceType string The type of element for example graphic button or animation symbolID string An ar...

Page 53: ... the HTML Alt tag when exporting behaviors array Array of Behavior objects for the Hotspot for more information see Behavior object on page 33 color string Color in which the Hotspot is drawn in the Document window Default value is 00FFFF contour object Contour object for the Hotspot for more information see Contour object on page 36 Used only if shape polyline otherwise null shape string Acceptab...

Page 54: ...lText tdTagText string This string contains all the attributes of a table cell except the colspan and rowspan values An example value is bgcolor ff0000 valign top Property Data type Notes contours array Array of Contour objects on this Path object for more information see Contour object on page 36 isEvenOddFill Boolean true if the path uses an even odd fill pathAttributes object PathAttrs object f...

Page 55: ...alse pair kerning information in the fonts is ignored Default value is true orientation string Acceptable values are horizontal left to right the default vertical right to left horizontal right to left and vertical left to right pathAttributes object PathAttrs object for more information see PathAttrs object on page 68 randSeed float A 32 bit integer JavaScript integers hold only 31 bit numbers so...

Page 56: ...Boolean If set to true and the element mask is an image the image is automatically expanded to fill the entire document with areas outside the image showing through If set to false or if the element mask is not an image areas outside the element mask are knocked out element object Element object for more information see Element object on page 49 enabled Boolean If set to true the mask applies to t...

Page 57: ...element s fill and stroke are ignored Property Data type Notes delayTime integer For GIF animations the delay time between frames in 1 100ths of a second For example if you set delayTime to 200 two seconds elapse before the next frame in the animation appears Default value is 7 frameHidden Boolean If set to false the default the frame is exported If set to true the frame is hidden and not exported...

Page 58: ...positive and one is negative the positive value is always used This gives the following possibilities xSize 0 ySize 0 use min xSize ySize scaling xSize 0 ySize 0 use xSize scaling xSize 0 ySize 0 use ySize scaling xSize 0 ySize 0 use ySize scaling xSize 0 ySize 0 illegal use scale of 1 0 xSize 0 ySize 0 use ySize scaling xSize 0 ySize 0 use xSize scaling xSize 0 ySize 0 use xSize scaling xSize 0 y...

Page 59: ...bject on page 57 can be null the default interlacedGIF Boolean The default value is false jpegQuality integer 1 to 100 the default value is 80 jpegSmoothness integer 0 to 8 the default value is 0 jpegSubsampling integer 0 to 4 the default value is 1 localAdaptive Boolean The default value is true lossyGifAmount integer 0 to 100 the default value is 0 macFileCreator string The default value is an e...

Page 60: ...progressiveJPEG Boolean The default value is false savedAnimationRepeat integer The default value is 0 sorting string Acceptable values are none the default luminance and popularity transparencyIndex integer 1 to 255 pass 1 to use the background color s index default value is 1 useScale Boolean The default value is true webSnapAdaptive Boolean The default value is true webSnapTolerance integer The...

Page 61: ...color is selected in the panel selection is a temporary attribute The default value is false colorTransparent Boolean Set to true if the color is exported as transparent The default value is false newColorValue string If colorModified is set to true specifies the color that will actually be used The default value is 000000 Property Data type Notes baseName string The name from which all automatica...

Page 62: ... multiple HTML pages for button export htmlDestination string Acceptable values are same custom and clipboard setByUser Boolean If set to true the user specifies the export settings If set to false the first time the file is exported Fireworks chooses settings based on the data shimGeneration string Acceptable values are none no shims transparent one pixel transparent shims and nested tables no sh...

Page 63: ... and so on numeric1 generates a unique number 1 is first 2 is second and so on numeric01 generates a unique two digit number 01 is first 02 is second and so on doc name name of the file being exported without a path or extension such as image slice the string slice underscore the underscore character _ period the period character space the space character hyphen the hyphen character For example to...

Page 64: ...mber generates frame number for example 2 state generates frame state for example over down or overdown abbreviation generates abbreviated state for example o d or od underscore the underscore character _ period the period character space the space character hyphen the hyphen character sliceUsingUrls Boolean If set to true use slice objects for slicing and sliceAlongGuides should be set to false t...

Page 65: ...he name that appears in the Fill panel pattern object Pattern object see Pattern object on page 68 shape string Acceptable values are solid linear radial conical satin pinch folds elliptical rectangular bars ripple waves pattern and web dither stampingMode string Acceptable values are blend and blend opaque textureBlend float 0 to 100 webDitherTransparent Boolean If set to true and shape is set to...

Page 66: ...rIntersection object on page 66 visible Boolean If set to false this frame is hidden Default value is true Property Data type Notes elements array Array of Element objects see Element object on page 49 locked Boolean If set to true this FrameNLayerIntersection is locked Default value is false visible Boolean If set to false this FrameNLayerIntersection is hidden Default value is true Property Data...

Page 67: ...that specifies the color at this position in the gradient see Color string data type on page 11 isOpacityNode Boolean If set to true this node is part of the gradient s opacity ramp position float 0 0 to 1 0 Property Data type Notes color string A color string that specifies the color used for the guides see Color string data type on page 11 hGuides array Array of floating point numbers that speci...

Page 68: ...rIntersection objects see FrameNLayerIntersection object on page 66 layerType string Acceptable values are normal and web name string Might be null removes any existing name sharing string Acceptable values are shared and not shared Property Data type Notes brush object Brush object see Brush object on page 33 brushColor string A color string that specifies the color that is used for rendering the...

Page 69: ...llOnTop Boolean If set to true the fill is drawn on top of the brush if set to false the default the fill is drawn beneath the brush fillTexture object Texture object see Texture object on page 56 Property Data type Notes name string The name that appears in the Fill panel Property Data type Notes roundness float A floating point value between 0 and 1 that specifies the roundness to use for the co...

Page 70: ...in the key that you want to use to constrain the rotation A value of none means that rotation will not be constrained A value of shiftKey means that when the user holds downs the Shift key while dragging the mouse rotation will be constrained The value can be one of the following none shiftKey ctrlCmdKey altOptKey Note these points are set with minAngle and maxAngle constrainX float The value to c...

Page 71: ...ey ctrlCmdKey altOptKey A key value of none means dragging will not be constrained shiftKey or other value means that when the user holds downs Shift key or other value while dragging movement will be constrained constrain90Key string The key value that you want to use to constrain movement to the nearest 90º increment Can be one of the following none shiftKey ctrlCmdKey altOptKey A key value of n...

Page 72: ...tSideToY float The ratio of longest mouse movement to the movement of referenced point s y coordinate deltaXtoX float The ratio of mouse movement to the movement of the referenced point s x coordinate For example 1 0 means that when the mouse moves 1 pixel to the right the referenced point also moves 1 pixel to the right deltaXtoY float The ratio of mouse movement on the x axis to the movement of ...

Page 73: ... holds downs the Shift key while dragging the mouse rotation is not constrained incrementRadius float Constant value that is added to the radius incrementX float This amount is added to the x movement of the mouse when calculating the total movement incrementY float This amount is added to the y movement of the mouse when calculating the total movement maxAngle point The maximum angle that can be ...

Page 74: ...ue the x coordinate can move minY float The minimum value the y coordinate can move minRadius float The minimum radius value movePred Boolean Determines whether the predecessor point should be moved as the user moves the mouse movePt Boolean Determines whether the point itself should be moved as the user moves the mouse moveSucc Boolean Determines whether the successor point should be moved as the...

Page 75: ...DragInsertAspectKey string The key value that will cause the aspect ratio to be constrained during a DragInsert operation ctrlCmdKeyDown Boolean Indicates whether the Control Command key is pressed true if pressed otherwise false currentControlPoint object Returns the current control point object currentControlPointIndex integer Returns the index number of the current control point currentControlP...

Page 76: ... the DragControlPoint message from Fireworks see Fireworks messages on page 126 mouseDownPos point Location of the mouse during a mouse click operation string Message received from Fireworks see Fireworks messages on page 126 for possible messages prevMousePos point Location of the mouse at the previous drag message shiftKeyDown Boolean Indicates whether the Shift key is pressed Method Parameter D...

Page 77: ...brush property of the pathAttrs object when applying the style If set to false ignores the brush property The default value is false use_brushColor Boolean If set to true applies the brushColor property of the pathAttrs object when applying the style If set to false ignores the brushColor property The default value is false use_effectList Boolean If set to true applies the effects property of the ...

Page 78: ...extStyles property of the pathAttrs object when applying the style If set to false ignores the textStyles property The default value is false Property Data type Notes alignment string Acceptable values are left center right justify and stretch baselineShift integer The number of pixels above positive numbers or below negative numbers the baseline by which the characters are shifted bold Boolean Se...

Page 79: ...Larger numbers place more space between lines of text Smaller numbers move the lines closer together The exact effect of this property number depends on the value of the leadingMode property leadingMode string The only acceptable value is percentage which specifies that the leading property is a percentage of the text s point size A leading property of 1 0 means 100 percent or single spaced 2 0 me...

Page 80: ...suits your specific requirement generic HTML Dreamweaver compatible HTML and so on For each HTML template use a Slices htt file that generates the HTML for that particular template For more information see the Slices htt and Metafile htt files that are installed with Fireworks Property Data type Notes initialAttrs object TextAttrs object see TextAttrs object on page 78 textRuns array Array of Sing...

Page 81: ...ActionSwapImage 2 var kActionButtonDown 4 var kActionSwapImageRestore 5 var kActionButtonHighlight 6 var kActionButtonRestore 7 var kActionPopupMenu 9 behaviorText string For roundtrip HTML from Dreamweaver the JavaScript behaviors that don t have an equivalent in Fireworks borderColor string If action is set to 9 Popup Menu specifies the border color of the menu in hexidecimal borderSize integer ...

Page 82: ...lean If action is set to 2 Swap Image specifies if an external file is swapped in The value of hasHref is always the opposite of hasTargetFrame you cannot swap from two sources hasStatusText Boolean If action is set to 1 Status Message specifies if the status text is not empty hasTargetFrame Boolean If action is set to 2 Swap Image specifies if the swap image swaps is in another frame in the Firew...

Page 83: ...cell padding for the menu items menuItemSpacing integer If action is set to 9 Popup Menu specifies the spacing between menu items in points menuWidth integer If action is set to 9 Popup Menu specifies the width in points of the menu cell opaqueBackground Boolean If action is set to 9 Popup Menu specifies if the menu cell background is opaque preload Boolean If action is set to 2 Swap Image specifi...

Page 84: ... specifies the font family to use for the menu text textIndent integer If action is set to 9 Popup Menu specifies the left indent in points of the menu text textItalic Boolean If action is set to 9 Popup Menu true if the menu text is italic textOnly Boolean If action is set to 9 Popup Menu true if the pop up menu is to be text only textOverColor string If action is set to 9 Popup Menu specifies th...

Page 85: ...able values and notes All exportDoc properties are read only Property read only Data type Notes numberOfBehaviors integer The number of BehaviorInfo objects in the BehaviorsList array 0 or more see BehaviorInfo object on page 80 N OT E 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 ba...

Page 86: ...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 f...

Page 87: ...ple 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...

Page 88: ...g 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 Property read only or Method Data type Notes altText string The alternate text description for this slice if any beh...

Page 89: ...he area if shape is circle shape string Acceptable values are circle poly and rect targetText string Target text for this image if any xCoord index zero based index Returns the x coordinate for the specified point in pixels For example the following commands return the coordinates for the first point var x imagemap xCoord 0 var y imagemap yCoord 0 It is possible to have negative values if the imag...

Page 90: ...s the filename for the slice on the specified frame without directory or extension information For example when exporting a file base named Button Slices 0 0 getFrameFileName 0 returns Button_r1_c1 Generally all slices that have images have a frame filename For frames 1 and higher only slices that are rollovers or that are targeted by a swap image have names hasAltText Boolean Set to true if the s...

Page 91: ...bject on page 91 Set to null if the cell does not contain a nested table setFrameFileName frameIndex zero based index Sets the filename for the slice on the specified frame without directory or extension information You can stop an image from being exported by setting its name to an empty string skipCell Boolean Set to true if this cell in the table is covered by a previous row span or column span...

Page 92: ...e lists the properties of the Slices object along with their data types and where appropriate acceptable values and notes All Slices object properties are read only top integer Top of the cell in pixels The top starts at 0 width integer Width of the image in pixels including column spans Property read only Data type Notes demoIndex zero based index Index for each file generated for multiple file b...

Page 93: ...SliceHotspot basically a slice Path Group Instance Text RectanglePrimitive PathAttrs Image To test whether a text block is selected type the following code firstSelection fw selection 0 if firstSelection object Text alert I am a text block doSkipUndefined Boolean Set to true if Export Undefined Slices is not selected in Document Properties imagesDirPath string Relative URL to the images folder For...

Page 94: ... blendMode name mask To return the name of the selected object type the following code objectName fw selection 0 name The following properties contain other read only properties that you can return elementMask element linked enabled mode showAttrs autoExpandImages effectList name effects To return the name of the first effect that is applied to the selected object type the following code effectNam...

Page 95: ...nts when the elements are selected Hotspot shape urlText altText targetText contour behaviors returns an array of behaviors color To return the alt tag that has been applied to the currently selected Hotspot type the following code altTag fw selection 0 altText SliceHotspot SliceHotspot is a subclass of Hotspot A slice has all Hotspot properties plus the following properties baseName htmlText tdTa...

Page 96: ...p elements groupType To return the number of objects in a selected group type the following code numOfObjectsinGroup fw selection 0 elements length Instance symbolID transformMode instanceType urlText altText targetText To return the instanceType for the currently selected instance type the following code instance fw selection 0 instanceType NO TE For the complete list of path attributes propertie...

Page 97: ...llowing code antiAliasedSetting fw selection 0 antiAliasMode RectanglePrimitive Roundness pathAttributes originalSides transform To return the roundness setting for the currently selected rectangle type the following code roundness fw selection 0 roundness NO TE For the complete list of pathAttributes properties see pathAttributes on page 97 N OT E For the complete list of path attributes properti...

Page 98: ...is the valid set of pathAttributes subproperties that can be returned or set brushColor fillColor brush fill brushTexture fillTexture fillHandle1 fillHandle2 fillHandle3 brushPlacement fillOnTop To return the name of brush on the current path type the following code brush fw selection 0 pathAttributes brush name b ...

Page 99: ...r example a developer may want to create an ActionScript command so that a user can replace text in an image without leaving the current movie Similarly a Flash developer may create a panel so that a Fireworks user can easily create spirals and other nonstandard shapes repeatedly Cross product architecture The Fireworks cross product communication architecture provides a new way for extension deve...

Page 100: ...ection In this way an application written with ActionScript 2 0 or C running on the same computer as Fireworks only local connections are allowed to the loopback address can be used to open Fireworks documents slice them optimize them and then export them Users can also create a new Fireworks document through another application draw in the document and preview it in the browser Nearly anything th...

Page 101: ... E The RPC client is not required to disconnect after each XML request The RPC client can keep the connection open and send additional XML requests the TCP resubmission timeout is 30 seconds However only one XML request can be outstanding at a time In other words the RPC client cannot send a second request until it receives a reply to the first request because there is no queueing mechanism to hol...

Page 102: ...butes and no subelements In the following example the client requests the value of the appDir property of the object whose ID is 1 get obj 1 name appDir The set operation sets the object properties The set operation can contain only the obj and name attributes and exactly one parameter The parameter must be the same data type as the data type of the property being set or Fireworks will return an e...

Page 103: ...PC server fw is the Fireworks Application Object ID The Fireworks Application Object ID references the main application object in Fireworks and is of the Fireworks class This object is used to open and create documents In JavaScript it is the object referenced by App or fw smartShape is the SmartShape Object ID This object id references the global JavaScript variable smartShape and is used to crea...

Page 104: ...ded to the contained nodes Boolean bool bool value true The Boolean data type It can contain either true or false and nothing else Note that the values are case sensitive dictionary dict dict double key foo value 5 0 string key bar value fred dict A dictionary data type Like the array data type it is simply a container for other data nodes Each direct child node of a dictionary node must contain a...

Page 105: ...ect type The null type cannot have any attributes or sub elements server object obj obj value fw class Fireworks The server object data type The value attribute is set to the object ID The class attribute is optional The server always specifies the object class when sending replies to the client The client however is not required to specify the class when sending server object nodes to the server ...

Page 106: ...ing table N OT E When the server returns a server object it automatically retains the object on the client s behalf That is the object returned to the client is not destroyed until the client releases it with a release request or until the client disconnects from the server Therefore the client should release a server object as soon as the client has finished sending requests related to that objec...

Page 107: ...s an attribute Given an object s class the client can determine what methods and properties it has based on the Fireworks JavaScript DOM The DOM document also gives the prototypes of the methods and properties of a class The client can use the DOM document to determine the number and types of method parameters The DOM document uses more types in its prototypes than the RPC mechanism defines So sev...

Page 108: ...minutes value 15 int key seconds value 32 dict A date is a dictionary with the following subelement keys year month day hour minutes and seconds All six elements are integer data types dictionary dictionary dict dict Types map identically float float double value 5 132 Types map identically integer integer int value 7 Types map identically matrix dictionary dict array key matrix double value 1 0 d...

Page 109: ...dictionary dict double key top value 300 4 double key left value 234 0 double key bottom value 500 6 double key right value 564 0 dict A rect is a dictionary with four subelement keys top left bottom and right All four subelements are float data types resolution dictionary dict string key units value inch double key pixelsPerUnit value 72 0 dict A resolution is a dictionary with two subelement key...

Page 110: ...at have been retained on their behalf Additionally when a client disconnects all the server objects that have been retained on that client s behalf are released RPCMethods class To use remote procedure calls Flash developers need to create an instance of a Fireworks object and thereafter manage Fireworks objects carefully to save memory In ActionScript you should create blocks of code where you wi...

Page 111: ...Methods DestroyAutoReleasePool Usage RPCMethods DestroyAutoReleasePool Arguments None Returns Nothing Description Ends the auto release block and frees all allocated remote objects in the current auto release block function RPCMethods AddToAutoReleasePool Usage RPCMethods AddToAutoReleasePool proxyObject Arguments proxyObject The object to add to the current pool Returns Nothing ...

Page 112: ...bject Usage RPCMethods ReleaseObject Object Arguments Object The name of the object to release from memory Returns Nothing Description Releases an object from memory This function searches the specified object and all its properties for proxy objects If proxy objects are found they are released from memory Creating auto release blocks Rather than constantly tracking which objects to release and ho...

Page 113: ...ed as selObject is removed RPCMethods CreateAutoReleasePool var selObject fw selection get 0 RPCMethods RemoveFromAutoReleasePool selObject RPCMethods DestroyAutoReleasePool Now you can use the selObject object outside the auto release block Additionally you can nest auto release blocks that is you can create an auto release block and then call a function that creates its own auto release block Th...

Page 114: ...ll panels this function commented out as it will crash if run from inside Fireworks fw setHideAllFloaters true Define the document objects the long way var res new Object res units inch res pixelsPerUnit 72 var size new Object size x 220 size y 220 Create new doc var fwdoc fw createFireworksDocument size res 0033FF Define a rectangle object the short way var rect left 10 top 10 right 210 bottom 21...

Page 115: ...acromedia API wrapper extension to Macromedia Flash for creating Shockwave files that communicate with the Fireworks API By leveraging the new API communication between Macromedia Flash and Fireworks Fireworks extension developers can create command interfaces and dialog boxes that go beyond the alert and prompt dialog boxes supported in previous versions You can add command panels to Fireworks fo...

Page 116: ...er act as panels in the Fireworks interface at runtime and are available through the Window menu Shockwave files that are published to the Configuration Commands folder act as modal commands and are available through the Commands menu in the Fireworks interface At runtime Fireworks starts Flash Player which either plays Shockwave animations or runs commands if the user selects the custom command o...

Page 117: ...lue true to commit changes false otherwise If it is set to false any pending changes are discarded To commit the changes endStatus must be set to true notifyString A string to notify the user of errors If the value of endStatus is false this argument holds a string used to notify the user of the error If endStatus is set to true notifyString is an empty string Returns Nothing Description This func...

Page 118: ...xecute statements To install the API wrapper make sure you have the Macromedia Extension Manager installed and double click the Extension file In Macromedia Flash the wrapper appears in the Components window as FWCommandComponents The following example shows a command without the wrapper var path MMExecute fw appPatternsDir The following example shows the same command using the wrapper var path fw...

Page 119: ... the following ActionScript code Stage align TC Stage scaleMode noScale Events Fireworks events for Flash panels allow developers to write event handlers for specific user interaction For example a panel for creating a customized shape can respond to the user changing the stroke attribute and make changes to the lines in the shape accordingly How event handlers work When a panel is launched and th...

Page 120: ...t when the user creates an non scriptable history step onFWIdle0 Sent when Fireworks is in the first of a sequence of idle states Because Fireworks may often go through a sequence of idle states triggering functions by this event may impair application performance onFWIdle1 Sent when Fireworks is in the second of a sequence of idle states Because Fireworks may often go through a sequence of idle s...

Page 121: ...n the user changes focus in 2 or 4 Up view onFwPixelSelectionChange Sent when the pixel selection changes onFwActiveSelectionChange Sent when the selection changes in a document onFwActiveDocumentChange Sent when the user creates a new document closes a document opens a document or switches between open documents onFwActiveToolParamsChange Sent when the user changes the tool stroke or fill attribu...

Page 122: ...ormation see fw enableFlashDebugging on page 312 and fw disableFlashDebugging on page 311 Use the Flash debugging functions to show or hide everything that the Shockwave file passes to the Fireworks API during execution Place these debug functions around the suspect code in your Macromedia Flash ActionScript to turn the debugging functions on or off as needed Be careful to use these functions only...

Page 123: ...files in this directory contain the JavaScript for each Auto Shape You can open the files in an editor to see the script for each shape The Auto Shape file contains a collection of functions that handle the communication between Fireworks and the Auto Shape object for more information see Handling the user interaction on page 126 define the properties of the Auto Shape and provide supporting funct...

Page 124: ...h smartShape elem elements 0 contours 0 new Contour smartShape elem elements 0 contours 0 nodes 0 new ContourNode smartShape elem elements 0 contours 0 nodes 0 predX 0 smartShape elem elements 0 contours 0 nodes 0 predY 0 smartShape elem elements 0 contours 0 nodes 0 x 0 smartShape elem elements 0 contours 0 nodes 0 y 0 smartShape elem elements 0 contours 0 nodes 0 succX 0 smartShape elem elements...

Page 125: ...s an array of ContourNode objects see ContourNode object on page 37 You can write a helper function to simplify the code and assign ContourNode properties as shown in the following example function addPathPoint contour i x y var theNodes contour nodes Increase the length to add a new point if i 0 theNodes length get the new point var node theNodes theNodes length 1 Set the new point s values node ...

Page 126: ...orks sends a series of messages to the Auto Shape object as the user performs certain operations on the Auto Shape You can write a series of functions to respond to these messages Fireworks messages Fireworks passes the following messages to the SmartShape object as the user interacts with inserts moves or changes the shape InsertSmartShapeAt Fireworks sends this message when the user selects the ...

Page 127: ... stages of a drag operation at the beginning of the operation during the operation and at its end If you define only the properties for the end result Fireworks waits until the drag operation ends to show the changes to the user For example to have your Auto Shape respond to an EndDragControlPoint message you would write the following function function EndDragControlPoint cp x smartShape currentMo...

Page 128: ...ontrolPointIndex case 0 var parms smartShape GetDefaultMoveParms smartShape elem controlPoints 0 RegisterMove parms smartShape elem elements 0 contours 0 nodes 0 RegisterMov e parms break DragControlPoint This function is called every time the mouse moves during a drag operation Fireworks can change the object as the user moves the mouse or wait until the mouse event ends to change the object If t...

Page 129: ...this switch statement in each of the Auto Shape JavaScript files Again a single Auto Shape object may not need to process every message Fireworks sends so only the useful messages are written into the JavaScript file using the case qualifier Effectively the JavaScript file states in case of a certain message or messages perform the following function In the Frame Auto Shape this code is used to ca...

Page 130: ...e message handling functions so they can be used by multiple message handling functions For example the Cog Auto Shape JavaScript file Configuration Auto Shapes Cog jsf contains user defined functions near the bottom of the file These functions perform calculations and create shapes that are useful for the message handling functions The top of the file contains a series of variable statements that...

Page 131: ...ly to all functions Zero based indexes Some functions take an index argument which is a zero based one dimensional array That means a value of 0 represents the first item in the array 1 represents the second item and so on For example the following command deletes the second layer of the active Fireworks document fw getDocumentDOM deleteLayer2 Functions that take a frameIndex argument can be passe...

Page 132: ...floating windows that are available within Fireworks Therefore when the function name contains palette the descriptions refer to a panel Document functions As discussed in an earlier section you get and set document properties by calling functions as methods of the document s Document Object Model DOM see Accessing a Fireworks document on page 10 Methods that operate on a document s DOM are listed...

Page 133: ... Nothing Description Adds a specified behavior to the selected Hotspots and slices Example The following command adds a simple rollover behavior at the end of the selected slice or Hotspot fw getDocumentDOM addBehavior MM_simpleRollover onMouseOver 1 See also dom removeBehavior Using the dom addBehavior function The following code shows the syntax for dom addBehavior fw getDocumentDOM addBehavior ...

Page 134: ...lue that specifies whether to preload the swapped image pass 1 or not pass 0 Description Sets a navigation bar Down behavior Example fw getDocumentDOM addBehavior MM_nbGroup down navbar1 1 2 1 onClick 1 MM_nbGroup highlight Availability Fireworks 3 Arguments type target swapFrame fileName preload downHighlight downHighlightFrame downHighlightFilename Pass over for type target specifies the slice t...

Page 135: ...a frame to use in downHighlightFrame pass an empty text string If you want to specify a filename and you passed 1 for downHighlightFrame pass the string for the relative URL of the image Description Sets a navigation bar highlight behavior Example fw getDocumentDOM addBehavior MM_nbGroup over 1 1 1 0 3 onMouseOver 1 MM_nbGroup image Availability Fireworks 3 Arguments type downHighlight initiallyDo...

Page 136: ...DOM addBehavior MM_nbGroup out onMouseOut 1 MM_simpleRollover Availability Fireworks 3 Arguments None Description Adds a simple rollover behavior Example fw getDocumentDOM addBehavior MM_simpleRollover onMouseOver 1 MM_statusMessage Availability Fireworks 3 Arguments message message is a string that specifies the status message to appear Description Sets a status bar message ...

Page 137: ...e fileName as a URL pass 1 here fileName specifies the frame or file to swap If you specified a frame to use in swapFrame pass an empty text string If you want to specify a filename and you passed 1 for swapFrame pass the string for the relative URL of the image preload is a binary value that specifies whether to preload the swapped image pass 1 or not pass 0 restore is a binary value that specifi...

Page 138: ...operate the same as reveal all and hide all respectively bEnterMaskEditMode If bEnterMaskEditMode optional is set to true Fireworks enters mask edit mode on the newly added mask if omitted it defaults to false Returns Nothing Description Adds a new empty mask to the selected element If the selection already has an element mask it is replaced with the new one Only one element can be selected when c...

Page 139: ...s two frames and bAdvanceActiveFrame is omitted or true then the third frame becomes the active frame Returns Nothing Description Adds one or more frames to the document Example The following command adds one frame after the current frame but does not change the active frame fw getDocumentDOM addFrames 1 after current false dom addGuide Availability Fireworks 3 Usage dom addGuide float position gu...

Page 140: ... hotspot kind Acceptable values are hotspot and slice hotspot shape Acceptable values are rectangle and oval boundingRectangle A rectangle that specifies the bounds within which the Hotspot is placed see Rectangle data type on page 12 Returns Nothing Description Adds a new Hotspot that fits into the specified bounding rectangle Example The following command adds a new rectangle slice with the spec...

Page 141: ...new image Returns Nothing Description Adds a new empty transparent image to the document Example The following command adds an empty image that is 500 by 500 pixels in size and then enters bitmap mode fw getDocumentDOM addNewImage left 0 top 0 right 500 bottom 500 true dom addNewImageViaCopy Availability Fireworks MX Usage dom addNewImageViaCopy Arguments None Returns Nothing Description Adds a ne...

Page 142: ...election for this to succeed The selection is cut from the previously active bitmap The new bitmap appears with Fireworks in paint mode dom addNewLayer Availability Fireworks 3 Usage dom addNewLayer name bshared Arguments name A string that specifies the name for the new layer If name is null a new layer name is generated bShared A Boolean value that specifies whether the new layer is shared Retur...

Page 143: ... added see Point data type on page 12 Returns Nothing Description Adds a new path between two points The new path uses the document s current default path attributes and is added to the current frame and layer Example The following command adds a new line between the specified coordinates fw getDocumentDOM addNewLine x 64 5 y 279 5 x 393 5 y 421 5 dom addNewOval Availability Fireworks 3 Usage dom ...

Page 144: ...Arguments boundingRectangle A rectangle that specifies the bounds within which the new rectangle is added see Rectangle data type on page 12 roundness A floating point value between 0 and 1 that specifies the roundness to use for the corners 0 is no roundness 1 is 100 roundness Returns Nothing Description Adds a new rectangle or rounded rectangle fitting into the specified bounds The rectangle use...

Page 145: ...ts in the specified bounds The rectangle primitive uses the document s current default path attributes is added on the current frame and layer and has several editable properties such as corner roundness and transformation The difference between a rectangle and a rectangle primitive is that a rectangle is a path that is shaped like a rectangle and a rectangle primitive preserves its rectangular qu...

Page 146: ...ettings If it is true the path s fill is set to None and the brush is set to something other than None Returns Nothing Description Adds a new path that consists of a single Bézier point The path uses the default fill stroke and so on and is added on the current frame and layer The point is selected after it is added Example The following command adds a new path that consists of a single Bézier poi...

Page 147: ...ee Point data type on page 12 outsidePoint Specifies a point on the radius of the star or polygon Returns Nothing Description Adds a new star or polygon shaped path Example The following command adds a five sided star fw getDocumentDOM addNewStar 5 1 true x 186 y 72 x 265 y 89 dom addNewSymbol Availability Fireworks 3 Usage dom addNewSymbol type name bAddToDoc Arguments type Acceptable values are ...

Page 148: ...ectangle bInitFromPrefs Arguments boundingRectangle A rectangle that specifies the bounds within which to place the new text box see Rectangle data type on page 12 bInitFromPrefs If bInitFromPrefs is false the default values for all style properties are used If it is true the most recent values set by the user are used Returns Nothing Description Adds a new empty text block within the specified bo...

Page 149: ...is selected this function adds to it a swap image behavior from the Hotspot or slice located at where in the document dom adjustExportToSize Availability Fireworks 3 Usage dom AdjustExportToSize sizeInBytes bOkToIncreaseSize Arguments sizeInBytes An integer that specifies the size to be used for exporting It is used as described in the following list If a document has no slices sizeInBytes adjusts...

Page 150: ...Description Adjusts the export settings as specified dom adjustFontSize Availability Fireworks MX Usage dom adjustFontSize amount Arguments amount The amount specified in points by which to change the font size Positive values such as 2pt increase the size while negative values such as 1pt decrease the size Returns Nothing Description Increases positive values or decreases negative values the font...

Page 151: ...Hotspot pt tolerance Arguments pt A point that specifies the x y coordinates of the point to be added see Point data type on page 12 tolerance A floating point value 0 that specifies the tolerance between the new point and the starting point of the polyline path If the new point is within tolerance of the starting point the polyline path is closed Returns Nothing Description Appends a point to the...

Page 152: ...he path the new point should be placed The new point is appended in front of the point that this integer represents To add a point to the beginning of the path pass 0 to add a point to the end of the path pass a large number controlPointFirst mainPoint and controlPointLast Points that specify the x y coordinates of the preceding control point the main point and the following control point of the n...

Page 153: ...to the selected unclosed polygon slice If an unclosed polygon slice is not selected then a new polygon slice is created with the single point that passed in dom applyCharacterMarkup Availability Fireworks 3 updated in Fireworks 4 Usage dom applyCharacterMarkup tag Arguments tag Acceptable values for tag are b i and u for bold italic and underline and fwplain which was added in Fireworks 4 for text...

Page 154: ...s effectList An EffectList object see EffectList object on page 48 If effectList is null this function removes all effects from the selection Returns Nothing Description Applies the specified effects to the selection Example The following command applies a drop shadow with an angle of 315 a blur of 4 a color of black and a distance of 7 see Drop Shadow object on page 44 fw getDocumentDOM applyEffe...

Page 155: ...iption Applies the specified font markup attribute to the selected text dom applyStyle Availability Fireworks 3 Usage dom applyStyle styleName styleIndex Arguments styleName A string that specifies the style name to be applied styleIndex An index to the style to apply This is usually zero However if there are multiple styles with the same name styleIndex is used to resolve the ambiguity 0 referenc...

Page 156: ...ange Availability Fireworks 3 Usage dom arrange arrangemode Arguments arrangemode Acceptable values for arrangemode are back backward forward and front Returns Nothing Description Arranges the selection Example The following command brings the selected items to the front fw getDocumentDOM arrange front dom attachTextToPath Availability Fireworks 3 Usage dom attachtTextToPath Arguments None Returns...

Page 157: ...ts currentPosition A floating point value that specifies the current position of the guide newPosition A floating point value that specifies the new position of the guide guidekind Acceptable values for guidekind are horizontal and vertical If guidekind is horizontal it is assumed that the specified positions are y coordinates if guidekind is vertical it is assumed that the specified positions are...

Page 158: ...ition and the new position This action resizes and possibly deletes rectangular slices that do not abut the slice guide at currentPosition isSingleDrag A Boolean value that determines whether the operation is performed only on the selected slice or on all slices that are affected by the slice guide If isSingleDrag is true Fireworks performs only the changeSliceGuide action on the selected slice Re...

Page 159: ...urns Nothing Description Clears the Selective JPEG mask for the document dom clipCopy Availability Fireworks 3 Usage dom clipCopy Arguments None Returns Nothing Description Copies the selection to the Clipboard Example The following command copies the selected items to the Clipboard fw getDocumentDOM clipCopy ...

Page 160: ... Example The following command copies the selected items to the Clipboard in Adobe Illustrator format fw getDocumentDOM clipCopyAsPaths dom clipCopyFormats Availability Fireworks MX Usage dom clipCopyFormats format Arguments format The graphics format for the selection For example AICB is the Adobe Illustrator format Returns Nothing Description Copies the selection to the Clipboard using the speci...

Page 161: ...ireworks 3 updated in Fireworks 4 Usage dom clipPaste whatIfResolutionDifferent whatIfPastingIntoElementMask Arguments whatIfResolutionDifferent An optional string that specifies how resampling should be done if the resolution of the Clipboard contents doesn t match the resolution of the document Acceptable values for whatIfResolutionDifferent are resample do not resample and ask user displays a d...

Page 162: ...to the document If there is a need for resampling Fireworks asks the user to decide how to resample fw getDocumentDOM clipPaste dom clipPasteAsMask Availability Fireworks 4 Usage dom clipPasteAsMask whatIfResolutionDifferent masktype maskReplaceOptions Arguments whatIfResolutionDifferent A string that specifies how resampling should be done if the resolution of the Clipboard contents doesn t match...

Page 163: ...t mask Only one element can be selected when calling this function If more than one element or none is selected when this function is called Fireworks throws an exception An exception is also thrown if there is nothing on the Clipboard dom clipPasteAttributes Availability Fireworks 3 Usage dom clipPasteAttributes Arguments None Returns Nothing Description Pastes the attributes from the Clipboard o...

Page 164: ...rgument is used to specify where to paste the color data Returns Nothing Description Pastes the specified color channel on the Clipboard into each of the RGB channels of a new image or into the specified channel of the selected image if any Example The following command copies the red data from the Clipboard into the red channel fw getDocumentDOM clipPasteFromChannelToChannel red red The following...

Page 165: ...ted element into the element mask for the pasted element s If the selected element already has a mask this function groups the pasted elements with the selected element and applies the existing element mask to the group Example The following command pastes the Clipboard contents inside the selected items If the resolution of the Clipboard doesn t match the resolution of the document Fireworks resa...

Page 166: ...nts bPromptToSaveChanges If bPromptToSaveChanges is true and the document was changed since the last time it was saved the user is prompted to save any changes to the document If bPromptToSaveChanges is false the user is not prompted and changes to the document are discarded Returns Nothing Description Closes the document dom convertAnimSymbolToGraphicSymbol Availability Fireworks 4 Usage dom conv...

Page 167: ...Fireworks 7 Usage dom convertMarqueeToPath Arguments None Returns Nothing Description Converts marquee selection to path dom convertPathToMarquee Availability Fireworks 7 Usage dom convertPathToMarquee mode featherAmount Arguments mode Sets the mode Acceptable values are hard edge antialias and feather featherAmount Sets the amount of feathering for the marquee selection This value is ignored if m...

Page 168: ...nt value that specifies the degrees of rotation to be applied to the animation symbol For example passing a value of 720 specifies an animation that does two complete clockwise rotations To rotate the animation counter clockwise pass a negative number scaleAmount A positive floating point value that specifies the amount of scaling to be applied to the animation symbol For example passing a value o...

Page 169: ...table paths Example The following command converts the selected text items into editable paths fw getDocumentDOM convertToPaths dom convertToSymbol Availability Fireworks 3 Usage dom convertToSymbol type name Arguments type Acceptable values are graphic button and animation name A name for the new symbol Returns Nothing Description Converts the selected item s to a new symbol ...

Page 170: ... the height of the filter coefficients kernelValues An array of integers that defines the values for specific filter patterns affectsAlpha A Boolean value true means the convolution filter affects the transparency of the bitmap false means that the bitmap transparency isn t affected by the filter Returns Nothing Description Applies convolution or irregular filters to the selected bitmap based on t...

Page 171: ...ltipleSelected An optional string that specifies how to create Hotspots if multiple items are selected Acceptable values for whatIfMultipleSelected are single creates a single Hotspot that has the same bounding rectangle as the selection multiple creates one Hotspot for each item and ask user displays a dialog box to let the user decide If whatIfMultipleSelected is omitted or null ask user is assu...

Page 172: ... fw getDocumentDOM copyToHotspot hotspot multiple dom cropSelection Availability Fireworks 3 Usage dom cropSelection boundingRectangle Arguments boundingRectangle A rectangle that specifies the bounds within which the selection should be cropped see Rectangle data type on page 12 Returns Nothing Description Crops the selection to the specified rectangle dom deleteAllInDocument Availability Firewor...

Page 173: ...ocation at which to begin deleting frames starting with 0 although to specify the current frame pass 1 howMany Specifies how many frames to delete Returns Nothing Description Deletes one or more frames dom deleteLayer Availability Fireworks 3 Usage dom deleteLayer layerIndex Arguments layerIndex An integer value that specifies the layer to be deleted starting with 0 although to specify the current...

Page 174: ...e pointIndex An integer value that specifies the point to be deleted starting with 0 although to specify the current point pass 1 here Returns Nothing Description Deletes the specified point on the currently selected path If the point is the only one on its contour the entire contour is deleted If the point is the only one in the path the entire path is deleted The specified point does not need to...

Page 175: ...elected items to transparent fw getDocumentDOM deleteSelection false dom deleteSelection Availability Fireworks 3 Usage dom deleteSelection bFillDeletedArea Arguments bFillDeletedArea This argument is ignored if Fireworks is not in bitmap mode If Fireworks is in bitmap mode and bFillDeletedArea is true the deleted pixels are filled with the current fill color If false the deleted pixels are filled...

Page 176: ...null If the deleted symbols contain any active instances in the document the instances are also deleted Returns Nothing Description Deletes the specified symbols from the library Example The following command deletes the selected symbols from the library as well as any active instances from the document fw getDocumentDOM deleteSymbol null dom detachInstanceFromSymbol Availability Fireworks 3 Usage...

Page 177: ...h items dom distribute Availability Fireworks 3 updated with distributeToCanvas parameter in Fireworks 8 Usage dom distribute distmode distributeToCanvas Arguments distmode Acceptable values are vertical and horizontal distributeToCanvas A Boolean value that determines whether items are distributed to the canvas Default value is false Returns Nothing Description Distributes the selection along a v...

Page 178: ...rames if necessary The first item on the layer goes to the first frame the second item to the second frame and so on New frames are added to the document if necessary If there is only one item in the specified layer this function has no effect dom distributeSelectionToFrames Availability Fireworks 3 Usage dom distributeSelectionToFrames Arguments None Returns Nothing Description Distributes the se...

Page 179: ...e Control key Windows or Command key Macintosh is pressed altOptKeyDown Specifies whether the Alt key Windows or Option key Macintosh is pressed Returns Nothing Description Drags the specified control point to the new location dom duplicateFrame Availability Fireworks 3 usage dom duplicateFrame frameIndex howMany where bDupeSelectionOnly Arguments frameIndex An integer value that specifies the fra...

Page 180: ...uplicateFrame 1 1 after current false dom duplicateLayer Availability Fireworks 3 Usage dom duplicateLayer layerIndex howMany where Arguments layerIndex An integer value that specifies the layer to duplicate starting with 0 although to specify the current layer pass 1 here howMany An optional integer that specifies how many times to duplicate the layer If omitted the layer is duplicated once where...

Page 181: ...bility Fireworks 3 Usage dom duplicateSelection Arguments None Returns Nothing Description Makes a duplicate of the selection offsetting it slightly from the original Example The following command duplicates the selected items fw getDocumentDOM duplicateSelection See also dom cloneSelection dom duplicateSelectionToFrameRange Availability Fireworks 3 Usage dom duplicateSelectionToFrameRange frameIn...

Page 182: ...uplicates are not placed on that frame Returns Nothing Description Duplicates the selection to a range of frames of the document dom duplicateSelectionToFrames Availability Fireworks 3 Usage dom cuplicateSelectionToFrames whichFrames Arguments whichFrames Acceptable values are all previous next and end Note that end means the last frame of the document it does not add a new frame Returns Nothing D...

Page 183: ...Usage dom duplicateSymbolForAlias Arguments None Returns Nothing Description If any symbol instances are selected this function makes duplicate symbols of all the symbols that are pointed to by those instances The selected instances are updated to point to the new duplicate copies of the symbols Duplicate symbols always result in nonlinked duplicates The use of the word alias in the function name ...

Page 184: ... MX Usage dom enableElementMask enable selectAndEnterPaintModeIfPossible newSelectionMask Arguments enable A Boolean value that toggles the element mask between enabled true and disabled false selectAndEnterPaintModeIfPossible A Boolean value that determines the mode for the mask If selectAndEnterPaintModeIfPossible is true and the mask is a bitmap mask then bitmap mode is entered for the mask It ...

Page 185: ...aliasing on or off for the selected blocks of text dom enterElementMaskEditMode Availability Fireworks 4 Usage dom enterElementMaskEditMode Arguments None Returns Nothing Description Places Fireworks in element mask edit mode for the selection If the selection contains no mask elements Fireworks throws an exception NO TE To set the level of anti aliasing call the function dom setTextAntiAlisasing ...

Page 186: ...n is set on the currently selected bitmap after entering paint mode This argument is null by default Returns Nothing Description Enters image edit mode on the selected items Has no effect if nothing is selected or if a nonimage item is selected dom exitElementMaskEditMode Availability Fireworks 4 Usage dom exitElementMaskEditMode Arguments None Returns Nothing Description Takes Fireworks out of el...

Page 187: ...L Arguments fileURL A string which is expressed as a file URL that specifies the GIF or ACT file that is used to replace the color panel Returns true if the file is read successfully false if the file is not the expected format or is not read successfully for any other reason Description Replaces the values in dom exportOptions paletteEntries with those in the specified GIF or ACT file This functi...

Page 188: ...tion does not modify the document For more information see ExportOptions object on page 58 dom exportTo Availability Fireworks 3 Usage dom exportTo fileURL exportOptions Arguments fileURL A string which is expressed as a file URL that specifies the name of the exported file exportOptions An ExportOptions object see ExportOptions object on page 58 This argument is optional If this argument is omitt...

Page 189: ...assed for tolerance edgemode and featherAmt This behavior is the same as if the Magic Wand tool were used at the clickPt location tolerance An integer between 0 and 255 inclusive that specifies the tolerance for selecting pixels edgemode Acceptable values for edgemode are hard edge antialias and feather featherAmt An integer between 0 and 32 000 inclusive that specifies the number of pixels to fea...

Page 190: ... capable of also being Live Effects can be applied using this function To apply other types of external filters use dom filterSelectionByName Example The following command runs the selected pixels through the hue saturation filter and then sets hue to 30 and saturation to 20 fw getDocumentDOM filterSelection EffectMoaID 3439b08d 1922 11d3 9bde00e02910d580 hls_colorize true hue_amount 30 lightness_...

Page 191: ...string that specifies the category of the pixel filter to be applied Acceptable values depend on which filters you have installed name A string that specifies the name of the pixel filter to be applied Acceptable values depend on which filters you have installed Returns Nothing Description Applies the specified pixel filter to the selection as a permanent action not as a Live Effect To apply filte...

Page 192: ...ull if no objects have the specified name Description Looks for elements that have the specified name See also dom setElementName dom flattenDocument Availability Fireworks 3 Usage dom flattenDocument Arguments None Returns Nothing Description Flattens the entire document into a single pixel image This is the same behavior as the Merge Layers command dom flattenSelection Availability Fireworks 3 U...

Page 193: ... 3 Usage dom getFontMarkup fontAttribute Arguments fontAttribute Acceptable values for fontAttribute are size color and face Returns A string that specifies the markup value Returns null if the text has multiple attributes or if the selection contains no text Description Gets a font markup attribute for the selected text dom getPixelMask Availability Fireworks 3 deprecated in 4 Usage dom getPixelM...

Page 194: ...sk The result of this call could be used to call dom enableElementMask on page 184 or dom enterPaintMode on page 186 dom getSelectionBounds Availability Fireworks 3 Usage dom getSelectionBounds Arguments None Returns A rectangle see Rectangle data type on page 12 Returns null if nothing is selected Description Gets the bounding rectangle of the selection dom getShowGrid Availability Fireworks 3 Us...

Page 195: ...om getShowGuides Arguments None Returns true if the guides are visible false otherwise Description Determines if the guides are visible dom getShowRulers Availability Fireworks 3 Usage dom getShowRulers Arguments None Returns true if the rulers are visible false otherwise Description Determines whether the rulers are visible ...

Page 196: ... false otherwise Description Determines if the Snap to Guides function is available dom getSnapToGrid Availability Fireworks 3 Usage dom getSnapToGrid Arguments None Returns true if the Snap to Grid function is active false otherwise Description Determines whether the Snap to Grid function is active dom getTextAlignment Availability Fireworks 3 Usage dom getTextAlignment ...

Page 197: ...ailability Fireworks 3 argument deprecated in 4 Usage dom group type Arguments type An optional string that specifies how to group the items Acceptable values are normal mask to image and mask to path If the argument is omitted normal is assumed In Fireworks 4 mask to image and mask to path are deprecated Returns Nothing Description Groups the selection To ungroup elements use dom ungroup see dom ...

Page 198: ... in Fireworks 4 for text without character markup Returns true if the text has the specified character markup false if it does not or if only part of the text has the markup Description Determines whether the selected text has the specified character markup dom hideSelection Availability Fireworks 3 Usage dom hideSelection Arguments None Returns Nothing Description Hides the selection To redisplay...

Page 199: ...location and the third argument is ignored bMaintainAspectRatio If bMaintainAspectRatio is true the file is scaled to the largest size that fits within boundingRectangle while retaining the file s current aspect ratio This is a handy option for creating thumbnails If it is false the file is scaled to fill boundingRectangle Returns Nothing Description Imports the specified file at the specified loc...

Page 200: ... to import from the external file If it is false all the symbols in the external file are imported Returns Nothing Description Imports the specified external graphics file for example GIF JPEG or Fireworks document into the library of the document dom importSymbolButNotAsAlias Availability Fireworks MX Usage dom importSymbolButNotAsAlias filepath whichSymbol Arguments filepath The fileURL of the f...

Page 201: ...nch and edit operation false otherwise Description Specifies whether document was opened by a launch and edit operation dom insertPointInPath Availability Fireworks 3 Usage dom insertPointInPath contourIndex ptToInsertBefore tParameter controlPointFirst mainPoint controlPointLast Arguments contourIndex A zero based index that specifies the contour into which the Bézier point is inserted For paths ...

Page 202: ...ed See also dom appendPointToPath dom insertSmartShapeAt Availability Fireworks MX 2004 Usage dom insertSmartShapeAt name location useToolBlendModeOpacity Arguments name A string specifying the name of the Auto Shape location The upper left point of the Auto Shape useToolBlendModeOpacity Determines whether the new shape object should have the blend mode and opacity settings set for the Auto Shape ...

Page 203: ...inates Returns Nothing Description Inserts a symbol instance at the specified location dom isSelectionDirectlyAboveBitmapObject Availability Fireworks MX Usage dom isSelectionDirectlyAboveBitmapObject Arguments None Returns A Boolean value true if the selected objects are directly above an image element false otherwise Description Tests to see if the selected object s are directly above a bitmap o...

Page 204: ...specifies the x y coordinates of the point that the user clicked see Point data type on page 12 tolerance A floating point value 0 that specifies the tolerance within which items are cut Returns A Boolean value true if anything was cut false otherwise Description When the user clicks a single point while using the Knife tool this function cuts paths within the specified tolerance This action is si...

Page 205: ...Returns true if anything is cut false otherwise Description When the user drags while using the Knife tool this function cuts additional items within the specified tolerance This action is similar to using the Knife tool with a drag operation See also dom knifeElementsFromPoint dom linkElementMask Availability Fireworks 4 Usage dom linkElementMask frame layer element bLink Arguments frame An integ...

Page 206: ...ion Links or unlinks the element mask on the selected element If more than one element or no elements are selected when this function is called Fireworks throws an exception An exception is also thrown if the element has no element mask dom lockSelection Availability Fireworks 8 Usage dom lockSelection Arguments None Returns Nothing Description Locks the selection dom makeFind Availability Firewor...

Page 207: ...perform a search and replace operation in a document dom makeActive Availability Fireworks 3 Usage dom makeActive Arguments None Returns Nothing Description Makes the selected document active for editing dom mergeDown Availability Fireworks MX Usage dom MergeDown Arguments None Returns Nothing ...

Page 208: ...rary order ptToModify A zero based index that specifies the point to be modified controlPointFirst mainPoint and controlPointLast Points that specify the x y coordinates of the preceding control point the main point and the following control point of the new point see Point data type on page 12 dReapplyAttrs If dReapplyAttrs is true the path has the document s current fill stroke and so on reappli...

Page 209: ...election dom moveBezierHandleBy Availability Fireworks 3 Usage dom moveBezierHandleBy whichPath contourIndex ptToModify deltaControlPointFirst deltaControlPointLast Arguments whichPath A zero based index that specifies an index into the list of selected items indicating which item contains the Bézier handles to move contourIndex A zero based index that specifies the contour that contains the handl...

Page 210: ...n Returns Nothing Description For all the elements in the selection that have element masks linked or unlinked it moves the element masks by the specified amount Elements without element masks are ignored If no elements in the selection have element masks an exception is thrown dom moveFillVectorHandleBy Availability Fireworks 3 Usage dom moveFillVectorHandleBy delta whichHandle bConstrain bMoveJu...

Page 211: ...hat uses a fill vector for example a gradient fill this function adjusts the handles of the fill vector If the selection does not this function has no effect dom moveMaskGroupContentsBy Availability Fireworks 3 Usage dom moveMaskGroupContentsBy delta Arguments delta A point that specifies the x y coordinate values by which the element is moved see Point data type on page 12 For example passing x 1...

Page 212: ...amount without moving the pixels that are within the selection dom movePointOnHotspotBy Availability Fireworks 3 Usage dom movePointOnHotspotBy ptToModifyIndex delta Arguments ptToModifyIndex A zero based index that specifies which point on the path is to move delta A point that specifies the x y coordinate values by which the point is moved see Point data type on page 12 For example passing x 1 y...

Page 213: ...t determines whether this slice or Hotspot will be duplicated This argument is important for giving slices a unique name so their behaviors remain unaffected Returns Nothing Description If the selection is a Hotspot or slice of the polyline variety this function moves a point on the Hotspot s path by the specified amount dom moveSelectedBezierPointsBy Availability Fireworks 3 Usage dom moveSelecte...

Page 214: ...2 moves the selection 1 pixel to the right and 2 pixels down bMakeCopy The items that are copied instead of moved doSubSel If doSubSel is set to true the function moves only the subselected parts of a path If the argument is set to false the function moves the whole object Returns Nothing Description Moves the selected items by the specified amount or makes a copy of them and offsets them from the...

Page 215: ...ation bMakeCopy doSubSel Arguments location A point that specifies the x y coordinate values of the location to which the selection is moved or copied see Point data type on page 12 bMakeCopy Specifies copying instead of moving the selection doSubSel If doSubSel is set to true the function moves only the subselected parts of a path If the argument is set to false the function moves the whole objec...

Page 216: ...eCopy whatIfMultipleSelected elementIndex Arguments layerIndex An integer value that specifies the layer to which the selection should be moved or copied starting with 0 although to specify the current layer pass 1 here bMakeCopy If bMakeCopy is true the selection is copied instead of moved whatIfMultipleSelected An optional string that is used only if the destination is a web layer and bMakeCopy ...

Page 217: ...lements The maximum value is the number of elements previously in the layer meaning that the elements are moved to the bottom of the specified layer Returns Nothing Description Moves or copies the selection to the specified layer dom moveSelectionToNewLayer Availability Fireworks 3 Usage dom moveSelectionToNewLayer bMakeCopy Arguments bMakeCopy If bMakeCopy is true the selected items are copied in...

Page 218: ...in pixels This argument is ignored if the value of join is not miter cap Acceptable values are butt square and round join Acceptable values are bevel round and miter Returns Nothing Description Performs an expand operation on the selected paths dom pathInset Availability Fireworks 3 Usage dom pathInset width miter join Arguments width A floating point value that specifies the new width of the sele...

Page 219: ...the selected paths dom pathIntersect Availability Fireworks 3 Usage dom pathIntersect Arguments None Returns Nothing Description Performs an intersect operation on the selected paths dom pathPunch Availability Fireworks 3 Usage dom pathPunch Arguments None Returns Nothing Description Performs a punch operation on the selected paths ...

Page 220: ...at specifies how much to simplify This value corresponds to the value in the Modify Alter Path Simplify dialog box Returns Nothing Description Performs a simplify operation on the selected paths dom pathUnion Availability Fireworks 3 Usage dom pathUnion Arguments None Returns Nothing Description Performs a union operation on the selected paths ...

Page 221: ...rimary browser true or the secondary browser false Returns Nothing Description Previews the document in the primary or secondary browser dom rebuildColorTable Availability Fireworks 3 Usage dom rebuildColorTable Arguments None Returns Nothing Description Rebuilds the color table for the current export settings of the document This is the same behavior as choosing Rebuild Color Table from the Color...

Page 222: ...s Nothing Description Reinstates the last action that was undone in the document dom redraw Availability Fireworks MX Usage dom redraw Arguments None Returns Nothing Description Forces the document to redraw itself immediately This function is useful for providing feedback during complicated commands ...

Page 223: ...uto Shape outside a tool dom reflectSelection Availability Fireworks 3 Usage dom reflectSelection bHoriz bVert opts Arguments bHoriz If bHoriz is true the items are reflected horizontally bVert If bVert is true the items are reflected vertically opts Acceptable values are transformAttributes autoTrimImages and autoTrimImages transformAttributes Returns Nothing Description Reflects the selection ve...

Page 224: ...ty Fireworks 3 Usage dom removeBehavior event eventIndex Arguments event An optional argument specifying the event that triggers the behavior This argument is ignored by Fireworks eventIndex An integer value that specifies the location of the behavior to be removed starting with 0 although to specify the end location pass 1 here This argument is optional If you omit both optional arguments this fu...

Page 225: ...ge dom removeBrush Arguments None Returns Nothing Description Sets the brush of the selection to None dom removeCharacterMarkup Availability Fireworks 3 Usage dom removeCharacterMarkup tag Arguments tag Acceptable values are b i and u for bold italic and underline Returns Nothing Description Reapplies the default value for the specified markup type to the text in the selection ...

Page 226: ...mask and ask displays a dialog box to let the user decide If you pass ask and the user cancels the dialog box Fireworks returns an error Returns Nothing Description Removes the mask from the selected element If more than one element or no elements are selected when this function is called Fireworks throws an exception dom removeFontMarkup Availability Fireworks 3 Usage dom removeFontMarkup fontAtt...

Page 227: ...osition guidekind Arguments position A floating point value that specifies the position of the guide to be removed guidekind Acceptable values are horizontal and vertical If guidekind is horizontal it is assumed that position is a y coordinate if guidekind is vertical it is assumed that position is an x coordinate Returns Nothing Description Removes the specified guide If no guide is at that posit...

Page 228: ...oPutItBefore bMakeCopy Arguments frameToMove A zero based index that specifies which frame to move or copy frameToPutItBefore A zero based index that specifies where to place the frame that is to be moved or copied For example if you pass 1 for frameToMove and 0 for frameToPutItBefore the second frame is placed before the first frame bMakeCopy If bMakeCopy is true the specified frame is copied ins...

Page 229: ...e second layer is placed before the first layer bMakeCopy If bMakeCopy is true the specified layer is copied instead of moved Returns Nothing Description Moves or copies the specified layer before another specified layer dom replaceButtonTextStrings Availability Fireworks 3 Usage dom replaceButtonTextStrings newString uniformAttrs Arguments newString Specifies the string to be used as replacement ...

Page 230: ...gsInInstances newString uniformAttrs Arguments newString Specifies the string to be used as replacement text uniformAttrs If uniformAttrs is false each character retains the attributes of the character that was formerly in its position that is Fireworks preserves the existing formatting If uniformAttrs is true all characters assume the attributes of the first character in the string that is being ...

Page 231: ... existing formatting If uniformAttrs is true all characters assume the attributes of the first character in the string that is being replaced Returns Nothing Description Replaces the text of all selected text items with the specified string dom resizeSelection Availability Fireworks 3 Usage dom resizeSelection width height Arguments width and height Integers that specify the new width and height i...

Page 232: ...election named default will be restored fromDocument Index of a currently open document from which to load the selection If the from document is not specified the selection will be restored from the active document operation Operation to perform on the selection and on the document being loaded Acceptable values are new or replace add subtract and intersect This parameter is optional If the operat...

Page 233: ...hTextDirection Availability Fireworks 3 Usage dom reversePathTextDirection Arguments None Returns Nothing Description For all text on a path items in the selection it reverses the direction of the text along the path dom rotateDocument Availability Fireworks 3 Usage dom rotateDocument rotationAmount Arguments rotationAmount Acceptable values for rotationAmount are 90 180 and 270 Returns Nothing ...

Page 234: ...e values are transformAttributes autoTrimImages and autoTrimImages transformAttributes Returns Nothing Description Rotates the selection clockwise by the specified number of degrees Rotating 270º is the same behavior as rotating 90º counterclockwise dom save Availability Fireworks 3 Usage dom save bOkToSaveAs Arguments bOkToSaveAs If this optional argument is true or omitted and the file was never...

Page 235: ...string which is expressed as a file URL that specifies the directory and name under which the copy should be saved Returns true if the save operation is successful false otherwise Description Saves a copy of the document in a specified directory with a specified name This function does not affect the document s filePathForSave or isDirty properties dom saveJPEGMask Availability Fireworks 4 Usage d...

Page 236: ...t toDocument Index of a currently open document where the selection will be saved This parameter is optional If toDocument is not specified Fireworks will save the selection to the active document operation The operation to be performed on the selection and on the selection being loaded from the selectionName parameter Acceptable values are new or replace add subtract and intersect This parameter ...

Page 237: ...sents 200 and so on opts Acceptable values are transformAttributes autoTrimImages and autoTrimImages transformAttributes Returns Nothing Description Scales the selection in the horizontal and vertical axes Example The following command scales the selected items to approximately two thirds 67 and automatically trims the images and transforms the attributes fw getDocumentDOM scaleSelection 0 67 0 67...

Page 238: ...se smooth to smooth out the edge of the pixel selection by amount amount An integer specifying the amount by which to adjust Any integer is acceptable Returns Nothing Description Expands or reduces the pixel selection by the specified number of pixels selects a border of pixels or smooths the edge of the pixel selection dom selectAll Availability Fireworks 3 Usage dom selectAll Arguments None Retu...

Page 239: ...n of elements instead of simply selecting them This parameter is useful only if bRememberSelection is true Returns Nothing Description Selects all the items on the given layer in the current frame This function deselects objects on other layers If the only element on the layer is a bitmap Fireworks will enter paint mode on the bitmap dom selectChildren Availability Fireworks 3 Usage dom selectChil...

Page 240: ...by which to feather the selection Returns Nothing Description If Fireworks is in bitmap mode and a pixel selection is active this function feathers the selection by the specified number of pixels dom selectInverse Availability Fireworks 3 Usage dom selectInverse Arguments None Returns Nothing Description If Fireworks is in bitmap mode and a pixel selection is active this function inverts the pixel...

Page 241: ...election and has a Selection tool selected then this function deselects the pixels and exits image edit mode dom selectParents Availability Fireworks 3 Usage dom selectParents Arguments None Returns Nothing Description Selects the parents if any of the selection That is if all the members of a group are selected the individual members are deselected and the group is selected See also dom selectChi...

Page 242: ...lue is ignored if edgemode is not feather combinemode Specifies how to combine the new selection mask with the existing mask Acceptable values are replace add subtract and intersect Returns Nothing Description If Fireworks is in bitmap mode and a pixel selection is active this function selects all pixels in the current image that are within the specified tolerance of the average color in the curre...

Page 243: ...e Specifies how to combine the new selection mask with the existing mask Acceptable values are replace add subtract and intersect Returns Nothing Description Behavior is almost identical to dom selectSimilar except that the new mask is calculated from the color at the specified location in the image rather than from the average color in the selection See also dom selectSimilar dom sendEmail Availa...

Page 244: ... true all the elements on all layers appear in the Layers list If false only layer names appear on the list Returns Nothing Description Specifies whether all the elements in all layers appear in the Layers list See also dom setLayerDisclosure dom setAnimInstanceLoopCount Availability Fireworks 3 deprecated in 4 in favor of dom setAnimInstanceNumFrames Usage dom setAnimInstanceLoopCount loopCount A...

Page 245: ...mber of frames through which the symbol animates Returns Nothing Description Sets the number of frames to animate the currently selected animation element See also dom convertToAnimSymbol dom setAnimInstanceOffsetDist Availability Fireworks 4 Usage dom setAnimInstanceOffsetDist offsetDistPt Arguments offsetDistPt A point that specifies the distance the animation moves in pixels For example passing...

Page 246: ...t A floating point value that specifies the degree of rotation to be applied to the animation symbol For example passing 720 specifies an animation that does two complete clockwise rotations To rotate the animation counter clockwise pass a negative number Returns Nothing Description Sets the rotation amount in degrees to animate the currently selected animation element See also dom convertToAnimSy...

Page 247: ...cription Sets the scale amount to animate the currently selected animation instance See also dom convertToAnimSymbol dom setAnimInstanceStartEndOpacity Availability Fireworks 4 Usage dom setAnimInstanceStartEndOpacity startOpacity endOpacity Arguments startOpacity and endOpacity Float values between 0 and 100 that specify the starting and ending opacity of the animation symbol Returns Nothing Desc...

Page 248: ... starting frame value that appears in the Objects panel when a multiframe image instance is selected Returns Nothing Description Sets the start frame of the selected instances of multiframe image symbols dom setBlendMode Availability Fireworks 3 Usage dom setBlendMode mode Arguments mode Acceptable values are normal multiply screen darken lighten difference hue saturation color luminosity invert t...

Page 249: ...ction to the specified brush See also dom setBrushColor dom setBrushName dom setBrushNColorNTexture dom setBrushPlacement dom setBrushColor Availability Fireworks 3 Usage dom setBrushColor color Arguments color A color string see Color string data type on page 11 Returns Nothing Description Sets the brush color of the selection to the specified color See also dom setBrushNColorNTexture ...

Page 250: ...nt name of the brush newName A string that specifies the new name of the brush Returns Nothing Description Renames a brush Does not change the brush category dom setBrushNColor Availability Fireworks 3 Usage dom setBrushNColor brush brushColor Arguments brush A Brush object see Brush object on page 33 brushColor A color string see Color string data type on page 11 Returns Nothing Description Sets ...

Page 251: ... type on page 11 texture name The name of the texture to be applied Returns Nothing Description Sets the selection to the specified brush brush color and brush texture See also dom setBrushColor dom setBrushPlacement Availability Fireworks 3 Usage dom setBrushPlacement placement Arguments placement Acceptable values are inside center and outside Returns Nothing Description Specifies the brush plac...

Page 252: ...he user is editing a Button document this function turns automatic slicing on or off dom setButtonIncludeDownState Availability Fireworks 3 Usage dom setButtonIncludeDownState bIncludeDownState Arguments bIncludeDownState If bIncludeDownState is true the Down state is included in the button If bIncludeDownState is false it is not Returns Nothing Description If the user edits a Button document this...

Page 253: ...t Returns Nothing Description If the user edits a Button document this function specifies whether to include the Over While Down state in a button dom setButtonShowDownOnLoad Availability Fireworks 3 Usage dom setButtonShowDownOnLoad bShowDownOnLoad Arguments bShowDownOnLoad If bShowDownOnLoad is true the Down State on Load is shown in the button If bShowDownOnLoad is false it is not Returns Nothi...

Page 254: ...t specifies the name to be assigned to the slice that is associated with the button If it is null the slice is set to be named automatically statusMessage A string that specifies a status message to appear in the browser status line If an empty string or null is passed no status message appears Returns Nothing Description Sets the Button Export options If the user edits a button it sets options fo...

Page 255: ...tion Sets the fill vector on the selection to the default dom setDocumentCanvasColor Availability Fireworks 3 Usage dom setDocumentCanvasColor color Arguments color A color string see Color string data type on page 11 Returns Nothing Description Sets the canvas color of the document to the specified color Example The following command sets the canvas color to blue fw getDocumentDOM setDocumentCanv...

Page 256: ...moved Returns Nothing Description Sets the document s canvas size to the specified rectangle Example The following command sets the canvas to a size of 200 by 200 pixels fw getDocumentDOM setDocumentCanvasSize left 150 top 150 right 350 bottom 350 dom setDocumentCanvasSizeToDocumentExtents Availability Fireworks 3 Usage dom setDocumentCanvasSizeToDocumentExtents bGrowCanvas Arguments bGrowCanvas I...

Page 257: ...w getDocumentDOM setDocumentCanvasSizeToDocumentExtents true See also dom setDocumentCanvasSizeToSelection dom setDocumentCanvasSizeToSelection Availability Fireworks 3 Usage dom setDocumentCanvasSizeToSelection Arguments None Returns Nothing Description Calculates the size of all the items in the selection and resizes the document canvas accordingly See also dom setDocumentCanvasSizeToDocumentExt...

Page 258: ...12 Returns Nothing Description Scales the document to fit in the specified rectangle at the specified resolution dom setDocumentResolution Availability Fireworks 3 Usage dom setDocumentResolution resolution Arguments resolution Specifies the resolution for the document see Resolution data type on page 12 Returns Nothing Description Sets the resolution of the document dom setEffectName Availability...

Page 259: ...fy the current frame pass 1 layerNum A zero based integer that specifies the layer that contains the element or elements to be locked To specify the current layer pass 1 objectIndex A zero based integer that specifies the element or elements to lock or unlock 0 represents the topmost element in the specified layer To lock or unlock all the elements in the specified layer pass 1 bLock A Boolean val...

Page 260: ... true the element or elements are locked if false they are unlocked Returns An array of the elements for which the lock status is set Description Locks or unlocks all the elements with the specified name If no element has the specified name an exception is thrown If elements are hidden for example if they are on a hidden layer or frame the function will not lock them dom setElementMaskMode Availab...

Page 261: ...MaskShowAttrs Availability Fireworks 4 Usage dom setElementMaskShowAttrs bShow Arguments bShow If bShow is true the vector mask fill and stroke are visible if false they are hidden Returns Nothing Description Specifies whether the currently selected vector mask shows the fill and stroke dom setElementName Availability Fireworks 3 Usage dom setElementName name Arguments name A string that specifies...

Page 262: ...alue that specifies the layer that contains the element s to be shown or hidden starting with 0 although to specify the current layer pass 1 here elementIndex An integer value that specifies the element s to show or hide starting with 0 although to show or hide all the elements in the specified layer pass 1 here bShow If bShow is true the element s are visible If bShow is false they are hidden Ret...

Page 263: ...f the elements s for which visibility was set Description Shows or hides all the elements with the specified name If no element has the specified name an exception is thrown If the elements are hidden because they are on a hidden layer or frame for example this function does not show them See also dom findNamedElements dom setElementName dom setElementVisible dom setExportOptions Availability Fire...

Page 264: ... object see ExportSettings object on page 61 Returns Nothing Description Sets the document export settings dom setFill Availability Fireworks 3 Usage dom setFill fill Arguments fill A Fill object see Fill object on page 64 Returns Nothing Description Sets the selection to the specified fill dom setFillColor Availability Fireworks 3 Usage dom setFillColor color ...

Page 265: ...herAmt Arguments edgemode Acceptable values are hard edge antialias and feather featherAmt An integer that specifies the number of pixels to feather This value is ignored if edgemode is not feather Returns Nothing Description Sets the edge type for selected items with fills dom setFillNColor Availability Fireworks MX Usage dom setFillNColor fill color Arguments fill A Fill object see Fill object o...

Page 266: ...me of the texture to be applied Returns Nothing Description Sets the selection to the specified fill fill color and fill texture Example The following command sets the selected items to a linear fill with a feather edge and no texture fw getDocumentDOM setFillNColorNTexture category fc_Linear ditherColors 000000 000000 edgeType antialiased feather 10 gradient name cn_WhiteBlack nodes color ffffff ...

Page 267: ...ription Sets the fill placement for selected items with fills dom setFillVector Availability Fireworks 3 Usage dom setFillVector p1 p2 p3 Arguments p1 p2 and p3 Points that specify the x y coordinates of the three points used to calculate the fill vector see Point data type on page 12 Returns Nothing Description Sets the fill vectors of the selection to the specified absolute values ...

Page 268: ...ption Modifies the fill vectors of the selection by moving the fill start to the specified point and then moving the two fill end handles to the same relative position dom setGradientName Availability Fireworks 3 Usage dom setGradientName urrentName newName Arguments currentName A string that specifies the current name of the gradient newName A string that specifies the new name of the gradient Re...

Page 269: ...s grid origin see Point data type on page 12 Returns Nothing Description Sets the grid origin for the document dom setGridSize Availability Fireworks 3 Usage dom setGridSize gridSize Arguments gridSize A point that specifies the x y coordinates that are used for the document s grid size see Point data type on page 12 Returns Nothing Description Sets the grid size for the document ...

Page 270: ...rid dom setGroupType Availability Fireworks 3 arguments deprecated in Fireworks 4 Usage dom setGroupType type Arguments type An optional string that specifies how to group the items Acceptable values are normal mask to image and mask to path If the argument is omitted normal is assumed The mask to image and mask to path values are deprecated in Fireworks 4 Returns Nothing Description Changes the g...

Page 271: ...es To set the color of slice guides use dom setSliceGuideColor See also dom setSliceGuideColor dom setHotspotAltTag Availability Fireworks 3 Usage dom setHotspotAltTag whatToSet altTagString Arguments whatToSet Acceptable values are hotspots slices and hotspots and slices altTagString A string that specifies the text to be used for the alt tag Returns Nothing Description Sets the alt tag text to t...

Page 272: ...nd hotspots and slices color A color string see Color string data type on page 11 Returns Nothing Description Sets the color to the specified value for the Hotspots and slices in the selection Example The following command sets the color of the selected Hotspots to red fw getDocumentDOM setHotspotColor hotspots ff0000 dom setHotspotRectangle Availability Fireworks 3 Usage dom setHotspotRectangle b...

Page 273: ...Shape whatToSet shape Arguments whatToSet Acceptable values are hotspots slices or hotspots and slices shape Acceptable values are rectangle oval or polyline Returns Nothing Description Sets the specified Hotspots and slices in the selection to the specified shape dom setHotspotTarget Availability Fireworks 3 Usage dom setHotspotTarget whatToSet targetTagString Arguments whatToSet targetTagString ...

Page 274: ...string that specifies a URL that is already assigned to one or more Hotspots in the document If this value is not null the URLs of all Hotspots or slices in the document that have urlToMatch as their URL are changed to textString Note The URLs of both selected and unselected Hotspots or slices are changed bUpdateAttributes If bUpdateAttributes is true changed Hotspots inherit the color target and ...

Page 275: ...t specifies the layer that contains the elements to be displayed or hidden starting with 0 although to specify the current layer pass 1 here bDisclosed If bDisclosed is true all elements on the specified layer are displayed in the Layers list If bDisclosed is false only the layer name appears on the list Returns Nothing Description Specifies whether the elements on a specified layer appear in the ...

Page 276: ...ue all the layers on the specified frame are locked or unlocked and any value passed for layerIndex is ignored Returns Nothing Description Locks or unlocks one or all the layers on the specified frame Example The following command locks all the layers on the first frame fw getDocumentDOM setLayerLocked 1 0 true true dom setLayerName Availability Fireworks 3 Usage dom setLayerName layerIndex layerN...

Page 277: ...iesToAllFrames is true the items on the layer are duplicated to all the frames of the layer if false the items are placed only on the current frame bWarnUser If bWarnUser is true and bUnshareCopiesToAllFrames is enabled the user is asked to confirm that data on other frames can be overwritten If bWarnUser is false data on other frames of the layer is overwritten without warning Returns Nothing Des...

Page 278: ... layer is visible If bShow is false it is hidden bAllLayers If bAllLayers is true all the layers on the specified frame are shown or hidden and any value that is passed for layerIndex is ignored Returns Nothing Description Shows or hides a layer on the specified frame dom setMatteColor Availability Fireworks 3 Usage dom setMatteColor bUseMatteColor matteColor Arguments bUseMatteColor If bUseMatteC...

Page 279: ...e 11 If mask is null any existing pixel selection mask is removed howToCombineMasks If there was previously a mask and the new mask is also not null then howToCombineMasks specifies how the two masks should be combined Acceptable values for howToCombineMasks are replace add subtract and intersect Returns Nothing Description If Fireworks is in bitmap mode this function sets the pixel selection mask...

Page 280: ...on Sets the onion skinning options for the document Example The following command turns on onion skinning two frames before the selected frame and zero frames after it fw getDocumentDOM setOnionSkinning 2 0 dom setOpacity Availability Fireworks 3 Usage dom setOpacity opacity Arguments opacity A float variable between 0 and 100 inclusive Returns Nothing Description Sets the opacity of the selection...

Page 281: ... Creates a bounding quadrangle based on percentages of an arbitrary square and then transforms the selection within the bounding quadrangle The effect is the same as performing a transform operation within Fireworks and then replaying the Transform step from the History panel while other items are selected Example The following command performs the transform operation on the selection within the s...

Page 282: ...itive dom setRectSides dom setRectSides Availability Fireworks 4 Usage dom setRectSides newSides Arguments newSides A rectangle that specifies the new untransformed sides of the rectangle primitive see Rectangle data type on page 12 Rectangle primitives remember their transformations so the user sees the transformed result of newSides in the document Returns Nothing Description Modifies the untran...

Page 283: ...ansformAttributes Returns Nothing Description Moves and resizes the selection in a single operation dom setSelectionMask Availability Fireworks 4 Usage dom setSelectionMask mask howToCombineMasks Arguments mask Specifies the mask to be applied see Mask data type on page 11 If mask is null an existing pixel selection mask is removed howToCombineMasks If there was previously a mask and mask is not n...

Page 284: ... the Show Edges option is turned on If bShowEdges is false the option is turned off Returns Nothing Description Specifies whether the Show Edges option is on or off dom setShowGammaPreview Availability Fireworks 3 Usage dom setShowGammaPreview bPreviewGamma Arguments bPreviewGamma If bPreviewGamma is true the Preview Gamma option is turned on If bPreviewGamma is false the option is turned off Retu...

Page 285: ...eturns Nothing Description Specifies whether the grid is visible dom setShowGuides Availability Fireworks 3 Usage dom setShowGuides bShow Arguments bShow If bShow is true the normal guides are visible If bShow is false they are not visible Returns Nothing Description Specifies whether normal guides are visible dom setShowRulers Availability Fireworks 3 Usage dom setShowRulers bShow ...

Page 286: ...lity Fireworks 3 Usage dom setShowSliceGuides bShow Arguments bShow If bShow is true the slice guides are visible If bShow is false they are not visible Returns Nothing Description Specifies whether slice guides are visible dom setShowSliceOverlay Availability Fireworks 3 Usage dom setShowSliceOverlay bShow Arguments bShow If bShow is true the slice overlay is visible If bShow is false it is not v...

Page 287: ...ned on for the slice If bAutoname is false it is turned off Returns Nothing Description If a single slice is selected this function turns automatic naming on or off for the slice dom setSliceExportOptions Availability Fireworks 3 Usage dom setSliceExportOptions exportOptions Arguments exportOptions An ExportOptions object see ExportOptions object on page 58 Returns Nothing Description Sets the exp...

Page 288: ...on If a single slice is selected this function turns off automatic naming for the slice and sets its filename to the specified URL dom setSliceGuideColor Availability Fireworks 3 Usage dom setSliceGuideColor color Arguments color A color string see Color string data type on page 11 Returns Nothing Description Sets the color that is used to display slice guides To set the color of normal guides use...

Page 289: ...tion If a single slice is selected this function sets the slice s HTML text dom setSliceIsHtml Availability Fireworks 3 Usage dom setSliceIsHtml bHtml Arguments bHtml If bHtml is true sets the slices as HTML If bHtml is false sets the slices as Image Returns Nothing Description Sets the selected slices as HTML or Image dom setSnapToGrid Availability Fireworks 3 Usage dom setSnapToGrid bSnap ...

Page 290: ...lse they do not Returns Nothing Description Specifies whether tools snap to guides dom setSymbolProperties Availability Fireworks 3 Usage dom setSymbolProperties currentName symbolType newName Arguments currentName Specifies the current name of the symbol in the library If more than one master exists with a name of currentName only the first master is changed If null is passed in for currentName t...

Page 291: ...ment alignment Arguments alignment Acceptable values alignment are left center right justify stretch vertical left vertical center vertical right vertical justify and vertical stretch Returns Nothing Description Sets the alignment of the selected text items dom setTextAntiAliasing Availability Fireworks 3 Usage dom setTextAntiAliasing level Arguments level Acceptable values are crisp smooth and st...

Page 292: ...tems If bKern is false it is off Returns Nothing Description Specifies whether automatic kerning is on or off for the selected text items dom setTextCharSpacing Availability Fireworks MX Usage dom setTextCharSpacing charSpace Arguments charSpace A floating point percentage of the default space to add to positive values or remove from negative values two adjacent characters To increase the spacing ...

Page 293: ...4 8 or 16 that specifies the amount of oversampling used to anti alias text in custom mode Returns Nothing Description Sets the oversampling used to anti alias text in custom mode dom setTextCustomAntiAliasSharpness Availability Fireworks MX 2004 Usage dom setTextCustomAntiAliasSharpness sharpness Arguments sharpness An integer from 0 to 255 Returns Nothing Description Sets the sharpness value use...

Page 294: ...ly Returns Nothing Description Sets the strength value used to anti alias text in custom mode dom setTextFlow Availability Fireworks 3 Usage dom setTextFlow flowDirection Arguments flowDirection Acceptable values are left to right and right to left Returns Nothing Description Sets the horizontal flow direction of the selected text items dom setTextHorizontalScale Availability Fireworks MX Usage do...

Page 295: ... MX Usage dom setTextLeading leadingValue leadingMode Arguments leadingValue A floating point number that determines the spacing between two lines of text The meaning of leadingValue depends on leadingMode leadingMode Acceptable values are exact or percentage If set to exact leadingValue is the number of pixels between two lines of text If set to percentage leadingValue is a percentage of the defa...

Page 296: ...nd skew horizontal Returns Nothing Description Determines how the selected text on a path items are displayed dom setTextOnPathOffset Availability Fireworks 3 Usage dom setTextOnPathOffset offset Arguments offset A floating point value that specifies the offset distance in pixels Returns Nothing Description Sets the offset value between the items in the selected text on a path ...

Page 297: ...horizontal right to left and vertical left to right Returns Nothing Description Sets the horizontal vertical text orientation of the selected text items dom setTextParaIndent Availability Fireworks MX Usage dom setTextParaIndent paraIndent Arguments paraIndent The number of pixels by which to indent the first line of a paragraph Returns Nothing Description Sets the paragraph indention of text in p...

Page 298: ...paragraphs dom setTextParaSpacingBefore Availability Fireworks MX Usage dom setTextParaSpacingBefore paraSpaceBefore Arguments paraSpaceBefore The number of pixels to move down before starting a new paragraph Returns Nothing Description Sets the before paragraph spacing for text that is the number of pixels to move down from the previous paragraph before starting the new paragraph For vertical tex...

Page 299: ...hing Description Replaces the text in the selected text blocks with the styled text that is described by the TextRuns object passed in the argument dom setTransformMode Availability Fireworks 3 Usage dom setTransformMode mode Arguments mode Acceptable values are paths and pixels Returns Nothing Description Sets the transform mode for the selected text instance items or both ...

Page 300: ...tangle of the selected text item to the specified size This function causes the text to reflow inside the new rectangle the text item is not scaled or transformed Text that does not fit in the new rectangle is not visible dom setTextRectangleAuto Availability Fireworks 3 Usage dom setTextRectangleAuto Arguments None Returns Nothing Description Recalculates the bounding rectangle of the selected te...

Page 301: ... Left justified horizontal text is placed with its top and left edges at anchorPoint and the text expands to the right Centered horizontal text is centered horizontally around anchorPoint and expands equally to the left and right Centered vertical text is centered vertically around anchorPoint and expands equally up and down Returns Nothing Description Performs the same function as dom setTextRect...

Page 302: ...election See also dom hideSelection dom splitPaths Availability Fireworks 3 Usage dom splitPaths Arguments None Returns Nothing Description Splits the selected paths Compound paths are split into separate contours dom swapBrushAndFillColors Availability Fireworks 3 Usage dom swapBrushAndFillColors Arguments None ...

Page 303: ... Acceptable values some of which were added in Fireworks 4 are transformAttributes autoTrimImages autoTrimImages transformAttributes rememberQuad transformAttributes rememberQuad autoTrimImages rememberQuad and autoTrimImages transformAttributes rememberQuad Returns Nothing Description Transforms the selection using the specified three by three matrix dom tween Availability Fireworks 3 Usage dom t...

Page 304: ...ctions then you can undo the command all 10 JavaScript instructions and not just one JavaScript instruction within that command Most but not all JavaScript functions create an undoable action to be executed dom updateSymbol Availability Fireworks 3 Usage dom updateSymbol name Arguments name The name of a symbol in the library If more than one symbol exists with a name of name then only the first s...

Page 305: ...s Nothing Description Ungroups any grouped items in the selection To group items use dom group See also dom group Fireworks functions In Fireworks MX fw is synonymous with the Fireworks object All methods of the Fireworks object can be referred to as fireworks functionName or as fw functionName fw browseDocument Availability Fireworks 3 Usage fw browseDocument URL ...

Page 306: ... fw browseForFileURL browseType title previewArea Arguments browseType Acceptable values are open select and save The first two values display an Open dialog box each is acceptable for compatibility with Macromedia Dreamweaver The third value displays a Save dialog box title and previewArea Ignored by Fireworks but are accepted for compatibility with Dreamweaver Returns The file URL selected by th...

Page 307: ...Generally it is the last directory used Description Displays a dialog box that lets a user select a particular directory fw browseHelp Availability Fireworks MX Usage fw browseHelp helpID Arguments helpID The index number of the help topic to view Returns Nothing Description Opens the specified help topic in the help viewer fw checkFwJsVersion Availability Fireworks 3 Usage fw checkFwJsVersion ver...

Page 308: ...he argument is false Fireworks prompts the user to set the secondary browser Returns Nothing Description Displays a dialog box that lets the user select a primary or secondary browser fw chooseScriptTargetDialog Availability Fireworks 4 Usage fw chooseScriptTargetDialog formatlist Arguments formatlist A list of target documents for an operation Its use is similar to that in fw locateDocDialog exce...

Page 309: ...anges Arguments document A Document object that specifies the document to close see Document object on page 14 bPromptToSaveChanges An optional Boolean argument If bPromptToSaveChanges is true or omitted and the document has changed since the last time it was saved the user is prompted to save changes to the document If bPromptToSaveChanges is false the user is not prompted and any changes to the ...

Page 310: ... defaults use fw createFireworksDocument See also fw createFireworksDocument fw createDocumentWithDialog Availability Fireworks MX 2004 Usage fw createDocumentWithDialog Arguments None Returns The Document object for the newly created document see Document object on page 14 Description Shows the New Document dialog box and allows the user to create a new document fw createFireworksDocument Availab...

Page 311: ...nt see Document object on page 14 Description Opens a new document and selects it Values for size resolution and color are explicitly specified To open a new document with the current default values use fw createDocument Example The following command creates a new document that is 500 by 500 pixels in size with a resolution of 72 dpi and a solid white background color fw createFireworksDocument x ...

Page 312: ...e Arguments autoClose A Boolean value If set to true the Batch Progress dialog box closes automatically without user intervention when the script finishes Returns Nothing Description Closes the Batch Progress dialog box automatically when the script finishes This function has no effect if the Batch Progress dialog box does not appear fw enableFlashDebugging Availability Fireworks MX Usage fw enabl...

Page 313: ...on page 311 For more information about constructing Flash command panels for Fireworks see Flash panels on page 115 fw exportAndCopyHTMLCode Availability Fireworks MX Usage fw exportAndCopyHTMLCode document Arguments document A Document object for example fw documents 2 that specifies the document to export If document is null the active document is exported Returns A Boolean value true if success...

Page 314: ... otherwise Description Exports the specified document to the specified file as layers to be imported into Macromedia Director fw exportDirectorAsSlices Availability Fireworks MX Usage fw exportDirectorAsSlices document fileURL Arguments document A Document object for example fw documents 2 that specifies the document to export If document is null the active document is exported fileURL Specifies t...

Page 315: ...e Save As dialog box is displayed exportOptions An ExportOptions object see ExportOptions object on page 58 If exportOptions is null the document s current export options are used If the file format specified by exportOptions conflicts with the file format specified by fileURL then the extension of fileURL is changed to match the format specified by exportOptions Returns A Boolean value true if su...

Page 316: ...mages directory fw exportFrames null file C images fw exportHtmlAndImages Availability Fireworks 4 Usage fw exportHtmlAndImages doc htmlUrl imagesUrl Arguments doc A Document object that specifies the document to be exported see Document object on page 14 If doc is null the active document is exported htmlUrl The filename of the exported HTML file which is expressed as a file URL If htmlUrl is nul...

Page 317: ...images fw exportHtmlAndImages null file C mysite nav htm file C mysite images nav gif See also fw exportDocumentAs fw exportIllustrator Availability Fireworks MX Usage fw exportIllustrator document fileURL Arguments document A Document object for example fw documents 2 that specifies the document to export If document is null the active document is exported fileURL Specifies the filename for the e...

Page 318: ...herwise Description Exports a document s layers as individual images The image names are based on the names in the Layers panel The layers from the current frame are exported Example The following command exports the layers in the third open document to the C images directory fw exportLayers fw documents 2 file C images fw exportPSD Availability Fireworks 4 Usage fw exportPSD docObject PSDDocument...

Page 319: ...var kFlatten 2 var prevLayers fw getPref PsdExport_Layers fw setPref PsdExport_Layers kObjToLayer flatten layers or not var kEffectEditable 1 var kEffectRender 2 var prevEffects fw getPref PsdExport_Effects fw setPref PsdExport_Effects kEffectEditable var kTextEditable 1 var kTextRender 2 var prevText fw getPref PsdExport_Text fw setPref PsdExport_Text kTextRender fw exportPSD null file C new fold...

Page 320: ...fw setPref SwfMaintainTextEditable false maintain text editability at expense of appearance or not var prevExportAllFrames fw getPref SwfExportAllFrames fw setPref SwfExportAllFrames true if true all frames are exported var prevExportFromFrame fw getPref SwfExportFromFrame fw setPref SwfExportFromFrame 1 from frame only used ifSwfExportAllFrames is false var prevExportToFrame fw getPref SwfExportT...

Page 321: ...s registry such as Fireworks exe Returns A URL to the application This URL can be passed as an argument to fw launchApp If no such application can be found the URL is empty Description Attempts to find the path to the requested application On the Macintosh Fireworks looks for the application using a four character signature code In Windows Fireworks looks in the Windows registry under HKEY_LOCAL_M...

Page 322: ...UpFindReplace See Also fw setUpFindReplace fw findOpenDocument Availability Fireworks 3 Usage fw findOpenDocument docname Arguments docname A string that specifies the name of the document which is expressed as a file URL Returns If the document is open returns the Document object otherwise returns null see Document object on page 14 Description Determines whether the specified file is open in a F...

Page 323: ... getDocumentPath Availability Fireworks 3 Usage fw getDocumentPath document Arguments document A Document object for example fw documents 2 that specifies the document whose path and filename should be retrieved If document is null information about the active document is retrieved Returns The file URL for the document if it was saved or an empty string if it has not been saved Description Gets th...

Page 324: ...he panel see Rectangle data type on page 12 Description Gets the screen position and size of the specified panel NO TE Any panels not specified in the list of valid arguments like those in the Command Panels folder which are outside the Fireworks application should be named exactly as they appear in the file system without their file extension For example the valid argument name for the Align pane...

Page 325: ...specified panel is visible fw getHideAllFloaters Availability Fireworks 3 Usage fw getHideAllFloaters Arguments None Returns A Boolean value true if the panels are hidden false otherwise Description Returns the hidden or visible status of the panels N OT E Any panels not specified in the list of valid arguments like those in the Command Panels folder which are outside the Fireworks application sho...

Page 326: ... getNumberOfTables Availability Fireworks MX Usage fw getNumberOfTables filename Arguments filename The name of the file that contains the tables to be counted Returns A long integer that represents the number of tables in the document Description Returns the number of top level that is non nested tables in a document fw getPref Availability Fireworks 3 Usage fw getPref prefkey ...

Page 327: ... with the specified Preference key See also fw setPref fw launchApp Availability Fireworks MX Usage fw launchApp appPath filePathsToOpen Arguments appPath A file URL that specifies the executable to start Typically this value can be obtained by calling fw findApp filePathsToOpen An array of file URLs to open in the executable to start It is safe to pass an empty array Returns A Boolean value that ...

Page 328: ...w launchBrowserTo http www macromedia com Description Starts Fireworks primary web browser to open a URL fw locateDocDialog Availability Fireworks 4 Usage fw locateDocDialog maxnumdocs formatlist Arguments maxnumdocs Specifies the maximum number of documents to choose formatlist A list of acceptable file types to open The formatlist argument is an array of strings such as the ones shown in the fol...

Page 329: ...OpenAsNew bOpenWithWindowHidden Arguments fileURl A string or an array of strings each expressed as a file URL that specifies the files to be opened This argument is optional If fileURL is omitted or null the Open Document dialog box appears Value File type ADOBE AI3 Adobe Illustrator Fireworks JavaScript Fireworks JSF kMoaCfFormat_BMP Bitmap kMoaCfFormat_FreeHand7and8 Macromedia FreeHand 7 or 8 k...

Page 330: ...documents can be opened Description Opens the specified files in new document windows If a file is already open it opens again to avoid redundant open operations call findOpenDocument first See also fw findOpenDocument fw popupColorPicker Availability Fireworks MX Usage fw popupColorPicker screenLoc initialColor allowTransparent forceWeb216 Arguments screenLoc The location at which the dialog box ...

Page 331: ...olor initially selected in the dialog box For syntax details see Color string data type on page 11 allowTransparent A Boolean value that lets the user select a transparent color set to true for transparent false otherwise forceWeb216 A Boolean value that forces the chosen color to fall within the web216 panel set to true to force the color change false otherwise Returns The specified color in rrgg...

Page 332: ...ility Fireworks 3 Usage fw quitApplication Arguments None Returns Nothing Description Quits Fireworks but prompts the user to save any changed documents before exiting fw readNthTable Availability Fireworks MX Usage fw readNthTable filename tablenumber Arguments filename A fileURL for the file that contains the desired table tablenumber A long integer that specifies the desired table the tables ar...

Page 333: ...lepath The location of the panel state file as a string in the format file URL Returns Nothing Description Reads in a panel state file which is generated by fw writePanelStateToFile on page 345 and moves the panels Property inspector and toolbox to the appropriate locations fw replace Availability Fireworks 3 Usage fw replace Arguments None Returns The number of items that are replaced or 1 if the...

Page 334: ... items replaced or 1 if the search is not yet complete Description Performs a replace all operation on the active document using the current search and replacement strings See also fw setUpFindReplace fw revertDocument Availability Fireworks 3 Usage fw revertDocument document Arguments document A Document object for example fw documents 2 that specifies the document to be reverted This argument is...

Page 335: ...e is not a file URL that is if it does not begin with file it is assumed to be the name of a file in the Fireworks MX Configuration Commands folder Returns Result of script Description Executes a JavaScript file Example The following command runs a script found in the Align Center to Document jsf file which is located in the Commands folder fw runScript Align Center to Document jsf fw saveAll Avai...

Page 336: ...ull the active document is saved fileURL The name of the saved document which is expressed as file URL This argument is optional If fileURL is null or omitted the document is saved with its current name if the document has not been saved the Save As dialog box appears Returns Nothing Description Saves the specified document as a native Fireworks PNG file with the specified name To save a document ...

Page 337: ... also fw exportDocumentAs fw saveDocumentCopyAs Availability Fireworks 3 Usage fw saveDocumentCopyAs document fileURL Arguments document A Document object for example fw documents 2 that specifies the document to be saved If document is null the active document is saved fileURL The filename for the saved file which is expressed as a file URL If fileURL is null the Save As dialog box appears Return...

Page 338: ...s folder Returns Nothing Description Saves the specified string of JavaScript code as a JSF command file fw setActiveViewScale Availability Fireworks MX Usage fw setActiveViewScale scale center Arguments scale A floating point number where 1 0 is 100 or normal view and 1 5 is 150 Default is 6 center A point that defines the location in the document at which the view should be centered This argumen...

Page 339: ...ent is ignored by Fireworks It is included only for Dreamweaver compatibility Returns Nothing Description Sets the specified document as the active document Example The following command makes the fourth document the active document fw setActiveWindow fw documents 3 fw setFloaterGrouping Availability Fireworks 3 Usage fw setFloaterGrouping panelNameToMove panelNameToReceive Arguments panelNameToMo...

Page 340: ... tab from one panel to another or to its own panel Example The following command moves the Stroke tab from its current location into the panel named Object Although the panel name might be capitalized onscreen it must be passed as lowercase fw setFloaterGrouping stroke object fw setFloaterPosition Availability Fireworks 3 Usage fw setFloaterPosition panelName boundingRectangle NO TE Any panels not...

Page 341: ... url effect history mixer fill stroke swatches layers frames behaviors optimize library styles optimized colors options and toolbox NO TE Any panels not specified in the list of valid arguments like those in the Command Panels folder which are outside the Fireworks application should be named exactly as they appear in the file system without their file extension For example the valid argument name...

Page 342: ...e panels are hidden If bHide is false the panels are visible Returns Nothing Description Shows or hides the panels This behavior is the same as the Tab key behavior fw setPref Availability Fireworks 3 Usage fw setPref prefname prefval Arguments prefname and prefval A complete list of these values is beyond the scope of this documentation but the format of prefname and prefval exactly matches those...

Page 343: ...ified Preference key See also fw getPref fw setUpFindReplace Availability Fireworks 3 Usage fw setUpFindReplace findSpec Arguments findSpec A Find object see Find object on page 23 Returns Nothing Description Sets up a search fw toggleFloater Availability Fireworks 3 Usage fw toggleFloater panelName ...

Page 344: ... topmost fw ungroupPrimitives Availability Fireworks 4 Usage fw ungroupPrimitives Arguments None Returns Nothing Description Replaces selected primitive objects with their equivalent paths The new objects have all the attributes mask stroke fill and so on of the replaced ones See also dom addNewRectanglePrimitive NO TE Any panels not specified in the list of valid arguments like those in the Comma...

Page 345: ...RecoverFromError If bRecoverFromError is true and the HTML update encounters an error Fireworks displays a Confirmation dialog box and attempts to recover If it is false Fireworks fails without notifying the user if it encounters an error Returns A Boolean value true if the HTML was updated false otherwise Description Updates the HTML that was previously exported from Fireworks Example The followi...

Page 346: ...e fw yesNoDialog promptString Arguments promptString The prompt message that appears in the dialog box Returns A Boolean value true if the user selected the Yes button false otherwise Description Displays a dialog box that contains buttons labeled Yes and No Example The following code displays a dialog box with Yes and No buttons and the message Would you like to duplicate the element var shouldDu...

Page 347: ...s about the current document or selected object fw showPIWindow Availability Fireworks MX Usage fw showPIWindow Arguments None Returns Nothing Description Opens the Property inspector fw hidePIWindow Availability Fireworks MX Usage fw hidPIWindow Arguments None Returns Nothing Description Makes the Property inspector window invisible ...

Page 348: ...tion Determines whether the Property inspector window is currently expanded or minimized fw isPIVisible Availability Fireworks MX Usage fw isVisible Arguments None Returns A Boolean value true if visible false otherwise Description Determines whether the Property inspector window is currently hidden or shown fw growPIWindow Availability Fireworks MX Usage fw growPIWindow ...

Page 349: ...y inspector window fw shrinkPIWindow Availability Fireworks MX Usage fw shrinkPIWindow Arguments None Returns Nothing Description Minimizes the Property inspector window fw setPIPosition Availability Fireworks MX Usage fw setPIPosition pt Arguments pt A point in screen coordinates Returns Nothing ...

Page 350: ... is formatted as x float y float see Point data type on page 12 for syntax details which contains the location of the Property inspector Description Retrieves the location in screen coordinates of the upper left corner of the Property inspector window History panel functions These functions control the History panel fw historyPalette clearSteps Availability Fireworks 3 Usage fw historyPalette clea...

Page 351: ...fies which steps from the History panel should be copied If it is null the currently selected steps are used Returns Nothing Description Copies history steps to the Clipboard fw historyPalette getSelection Availability Fireworks 3 Usage fw historyPalette getSelection Arguments None Returns A zero based array that represents which History panel steps are selected Description Determines which steps ...

Page 352: ...y panel fw historyPalette getStepsAsJavaScript Availability Fireworks 3 Usage fw historyPalette getStepsAsJavaScript array of indexes Arguments array of indexes A zero based array that specifies which steps from the History panel should be returned as JavaScript If the argument is null the currently selected steps are returned Returns A JavaScript string Description Gets the JavaScript equivalent ...

Page 353: ...e used internally by Fireworks only and might change format in the future Do not try to parse this string or construct a custom string to pass to fw historyPalette setUndoState See also fw historyPalette setUndoState fw historyPalette replaySteps Availability Fireworks 3 Usage fw historyPalette replaySteps array of indexes Arguments array of indexes A zero based array that specifies which steps fr...

Page 354: ...ame An optional string that specifies a name for the JSF command file It can be any string including a file URL If filename is omitted or null the user is prompted for a filename If filename is not a file URL the file is saved in the Fireworks MX Configuration Commands folder with the specified filename Returns Nothing Description Gets the JavaScript equivalent of the specified steps and saves the...

Page 355: ...othing Description Performs the correct number of undo or redo operations to arrive at the selected state See Also fw historyPalette getUndoState Static Document Functions Fireworks has an older static Document object that has been deprecated in favor of the Document object in the DOM The static Document object is only only accessed by two methods You can access this API using document methodName ...

Page 356: ...ified name document makeGoodNativeFilePath Availability Fireworks 3 Usage document makeGoodNativeFilePath fileURL Arguments fileURL The name of the file which is expressed as a file URL whose extension should be changed to png Returns A string that contains the file URL with a png extension Description Ensures that the specified file URL ends in a png extension Does not affect the name of the file...

Page 357: ...upported in Fireworks and Dreamweaver to let developers easily create commands for both applications app toggleFloater Identical to fw toggleFloater app setFloaterVisibility Identical to fw setFloaterVisibility app getRootDirectory Identical to the Fireworks object property appDir app browseDocument Identical to fw browseDocument N OT E The app getRootDirectory function is useful if you want to us...

Page 358: ...358 Fireworks JavaScript API ...

Page 359: ...ty 357 app toggleFloater 357 appendPointToHotspot 151 appendPointToPath 152 appendPointToSlice 152 applyCharacterMarkup 153 applyCurrentFill 153 applyEffects 154 applyFontMarkup 155 applyStyle 155 arguments optional 10 arrange 156 attachTextToPath 156 Auto Shapes 123 defining 123 helper functions 125 icons 124 switch statement 129 B BeginDragControlPoint 127 BeginDragInsert 126 Behavior object 33 ...

Page 360: ...2 deleteAllInDocument 172 deleteFrames 173 deleteLayer 173 deletePointOnPath 174 deleteSelection 175 deleteSymbol 176 deprecated functions or arguments dom clipPasteInside 164 dom getPixelMask 193 dom group 197 dom setAnimInstanceStartFrame 248 dom setGroupType 270 dom setPixelMask 279 mask to image 50 mask to path 50 DestroyAutoReleasePool 111 detachInstanceFromSymbol 176 detachTextFromPath 177 d...

Page 361: ...olForAlias 183 dom elementsAt 183 dom enableElementMask 184 dom enableTextAntiAliasing 185 dom enterElementMaskEditMode 185 dom enterPaintMode 186 dom exitElementMaskEditMode 186 dom exitPaintMode 187 dom exportOptions loadColorPalette 187 dom exportOptions saveColorPalette 188 dom exportTo 188 dom fillSelectedPixels 189 dom filterSelection 190 dom filterSelectionByName 190 191 dom findExportForma...

Page 362: ...ectParents 241 dom selectSimilar 242 dom selectSimilarFromPoint 242 dom sendEmail 243 dom setAllLayersDisclosure 244 dom setAnimInstanceLoopCount 244 dom setAnimInstanceNumFrames 245 dom setAnimInstanceOffsetDist 245 dom setAnimInstanceRotationAmount 246 dom setAnimInstanceScaleAmount 246 dom setAnimInstanceStartEndOpacity 247 dom setAnimInstanceStartFrame 248 dom setBlendMode 248 dom setBrush 249...

Page 363: ...harSpacing 292 dom setTextCustomAntiAliasOverSample 293 dom setTextCustomAntiAliasSharpness 293 dom setTextCustomAntiAliasStrength 294 dom setTextFlow 294 dom setTextHorizontalScale 294 dom setTextLeading 295 dom setTextOnPathMode 296 dom setTextOnPathOffset 296 dom setTextOrientation 297 dom setTextParaIndent 297 dom setTextParaSpacingAfter 298 dom setTextParaSpacingBefore 298 dom setTextRectangl...

Page 364: ...ode 313 exportDirectorAsLayers 314 exportDirectorAsSlices 314 exportDoc object 85 exportDocumentAs 315 ExportFrameInfo object 57 exportFrames 315 exportHtmlAndImages 316 exportIllustrator 317 exporting HTML and sliced images 80 exportLayers 318 ExportOptions object 58 60 exportOptions loadColorPalette 187 exportOptions saveColorPalette 188 ExportPaletteInfo object 61 exportPSD 318 ExportSettings o...

Page 365: ...ables 326 fw getPIPosition 350 fw getPref 326 fw growPIWindow 348 fw hidePIWindow 347 fw historyPalette clearSteps 350 fw historyPalette copySteps 351 fw historyPalette getSelection 351 fw historyPalette getStepCount 352 fw historyPalette getStepsAsJavaScript 352 fw historyPalette getUndoState 353 fw historyPalette replaySteps 353 fw historyPalette saveAsCommand 354 fw historyPalette setSelection ...

Page 366: ...sJavaScript 352 historyPalette getUndoState 353 historyPalette replaySteps 353 historyPalette saveAsCommand 354 historyPalette setSelection 354 historyPalette setUndoState 355 Hotspot object 53 HTML export objects 80 Hue Effect object 45 Hue Saturation Effect object 45 I Image object 52 ImageMap object 88 89 ImagemapList object 89 importFile 199 importSymbol 199 importSymbolButNotAsAlias 200 index...

Page 367: ...potBy 212 movePointOnHotspotByWithFlags 213 moveSelectedBezierPointsBy 213 moveSelectionBy 214 moveSelectionMaskBy 214 moveSelectionTo 215 moveSelectionToFrame 216 moveSelectionToLayer 216 moveSelectionToNewLayer 217 N new features 6 null values 131 O object Behavior 33 BehaviorInfo 80 BehaviorsList 84 Brush 33 Contour 36 ContourNode 37 ContourNodeDynamicInfo 39 ControlPoint 39 Document 14 Effect ...

Page 368: ...ectangle 12 rectangle primitive 145 redo 222 redraw 222 reflectSelection 223 RegisterMoveParms 70 release 103 ReleaseObject 112 remote procedure calls 100 auto release blocks 112 data node 104 error codes 106 object ID 103 order 105 parameters 105 stubs 107 removeAllGuides 224 removeBehavior 224 removeBrush 225 removeCharacterMarkup 225 removeElementMask 226 removeFill 227 removeFontMarkup 226 Rem...

Page 369: ...setBrushPlacement 251 setButtonAutoSlice 252 setButtonIncludeDownState 252 setButtonIncludeOverWhileDownState 253 setButtonIncludeOverWhileDownState 253 setButtonOptions 254 setButtonOptions 254 setButtonShowDownOnLoad 253 setDefaultBrushAndFillColors 254 setDefaultFillVector 255 setDocumentCanvasColor 255 setDocumentCanvasSize 256 setDocumentCanvasSizeToDocumentExtents 256 setDocumentCanvasSizeTo...

Page 370: ...296 setTextOnPathOffset 296 setTextOrientation 297 setTextParaIndent 297 setTextParaSpacingAfter 298 setTextParaSpacingBefore 298 setTextRectangle 300 setTextRectangleAuto 300 setTextRectangleAutoFromPoint 301 setTextRuns 299 setTransformMode 299 setUndoState 355 setUpFindReplace 343 Sharpen Effect object 47 Sharpen More Effect object 48 showAllHidden 301 showPIWindow 347 shrinkPIWindow 349 Single...

Page 371: ...Index 371 V values 10 W Working with selected elements 132 write 13 WRITE_HTML 13 writePanelStateToFile 345 X XML 100 Y yesNoDialog 346 Z zero based indexes 131 ...

Page 372: ...372 Index ...

Reviews:

No comments

Brands by name

Popular brands

Load more brands