Adobe 65011817 Extended User Guide - Page 193

The Fireworks Object

Page 193 highlights

Last updated 12/8/2009 189 Chapter 4: The Fireworks Object The Fireworks object is a global object, which you can use to set or retrieve properties that relate to the current operating environment. (The App object that was used in Fireworks 3 is supported for backward compatibility, but its use is deprecated in favor of the Fireworks object.) The following table lists the properties of the Fireworks object, along with their data types and, where appropriate, acceptable values and notes. Read-only properties are marked with a bullet (•). Note: For information on how to format nonstandard data types, such as rectangle or point, see "Formatting nonstandard data types" on page 7. Refer to the Fireworks object by using fw.propertyName or fireworks.propertyName. Note that fireworks must be lowercase. Property activeTool activeViewScale appBatchCodeDir • appDir • appExportSettingsDir • Data type string float string string string appFavoritesDir • string appHelpDir • appHtmlCodeDir • appJsCommandsDir • appJsExtensionsDir • appMacCreator • appMacJsfFileType • appName • string string string string string string string Notes The active tool in the application. The scaling (zoom value) of the active view. 1.0=100% of the normal view. The path to the Batch Code directory, which is expressed as file://URL. The path to the directory that contains the Fireworks application, which is expressed as file://URL. 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. The path to the URL Libraries 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. The path to the directory that contains the Fireworks help file, which is expressed as file://URL. The path to the HTML Code directory, which is expressed as file://URL. The path to the Commands directory, which is expressed as file://URL. The path to the JSExtensions directory, which is expressed as file://URL. In the format: "MKBY" In the format: "TEXT" The name of the application ("Fireworks CS4"). This attribute is part of the common API, so it also appears as app.appName (as implemented in Adobe Dreamweaver).

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336

189
Las
t
up
d
a
ted
12/8/2009
Chapter 4: The Fireworks Object
The Fireworks object is a global object, which you can use to set or retrieve properties that relate to the current
operating environment. (The App object that was used in Fireworks 3 is supported for backward compatibility, but its
use is deprecated in favor of the Fireworks object.)
The following table lists the properties of the Fireworks object, along with their data types and, where appropriate,
acceptable values and notes. Read-only properties are marked with a bullet (•).
Note:
For information on how to format nonstandard data types, such as rectangle or point, see “
Formatting
nonstandard data types
” on page
7.
Refer to the Fireworks object by using
fw.propertyName
or
fireworks.propertyName
. Note that
fireworks
must
be lowercase.
Property
Data type
Notes
activeTool
string
The active tool in the application.
activeViewScale
float
The scaling (zoom value) of the active view. 1.0=100% of the
normal view.
appBatchCodeDir
string
The path to the Batch Code directory, which is expressed as
file://URL
.
appDir
string
The path to the directory that contains 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 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.
appHelpDir
string
The path to the directory that contains the Fireworks help file,
which is expressed as
file://URL
.
appHtmlCodeDir
string
The path to the HTML Code directory, which is expressed as
file://URL
.
appJsCommandsDir
string
The path to the Commands directory, which is expressed as
file://URL
.
appJsExtensionsDir
string
The path to the JSExtensions directory, which is expressed as
file://URL
.
appMacCreator
string
In the format: "MKBY"
appMacJsfFileType
string
In the format: "TEXT"
appName
string
The name of the application (
"Fireworks CS4"
). This
attribute is part of the common API, so it also appears as
app.appName
(as implemented in Adobe Dreamweaver).