Adobe 65011817 Extended User Guide - Page 151

dom.setElementLockedByName, dom.setElementMaskMode

Page 151 highlights

Last updated 12/8/2009 EXTENDING FIREWORKS 147 The Document object Usage dom.setElementLocked(frameNum, layerNum, objectIndex, bLock, bAllLayers, bLockLayers) Arguments frameNum A zero-based integer that specifies the frame that contains the element or elements to be locked. To specify 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 value. If true, the element or elements are to be locked; if false, the elements are unlocked. bAllLayers A Boolean value. If true, all layers are specified; false otherwise. bLockLayers A Boolean value. If true, locks all layers; false otherwise. Returns Nothing. Description Sets the name of the selected element or elements. dom.setElementLockedByName() Availability Fireworks 8. Usage dom.setElementLockedByName(name, bLock) Arguments name A string that specifies the name of the element or elements to be locked or unlocked. If more than one element has the same name, the function locks or unlocks all of them. bLock A Boolean value. If 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() Availability Fireworks 4.

  • 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

147
EXTENDING FIREWORKS
The Document object
Las
t
up
d
a
ted
12/8/2009
Usage
dom.setElementLocked(
frameNum, layerNum, objectIndex, bLock, bAllLayers, bLockLayers
)
Arguments
frameNum
A zero-based integer that specifies the frame that contains the element or elements to be locked. To specify
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 value. If
true
, the element or elements are to be locked; if
false
, the elements are unlocked.
bAllLayers
A Boolean value. If
true
, all layers are specified;
false
otherwise.
bLockLayers
A Boolean value. If
true
, locks all layers;
false
otherwise.
Returns
Nothing.
Description
Sets the name of the selected element or elements.
dom.setElementLockedByName()
Availability
Fireworks 8.
Usage
dom.setElementLockedByName(
name, bLock
)
Arguments
name
A string that specifies the name of the element or elements to be locked or unlocked. If more than one element
has the same name, the function locks or unlocks all of them.
bLock
A Boolean value. If
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()
Availability
Fireworks 4.