Adobe 65011817 Extended User Guide - Page 23

Find object

Page 23 highlights

Last updated 12/8/2009 EXTENDING FIREWORKS 19 The Fireworks Object Model Method close() readline() readLineUTF8 write(textString) writeUTF8 Data Type none none string string string Notes 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. 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 is longer than 2048 characters. Reads one line from the file that has been opened with UTF8 encoding. Writes the specified string to the current File Reference object. No end-of-line characters are appended; to include one, use "\n". Writes text in UTF8 encoding when the file is opened in UTF8 encoding. Find object There are several ways to specify a Find object, depending on what you want to find and replace. Use the whatToFind property to specify the type of find operation, along with the properties that are associated with each legal value for whatToFind. These properties are listed in the following tables. Read-only properties are marked with a bullet (•). Finding and replacing text Property whatToFind find matchCase numItemsReplaced • regExp Data type string string Boolean Integer Boolean replace wholeWord string Boolean Notes In the format: "text" Text to find. If set to true, the search is case-sensitive. Defaults to false. Number of replacements done in a file using Find and Replace. If set to true, the find and replace text is interpreted as a regular expression. The default is false. Text to use as replacement text. If set to true, only whole words matching the search text are found. The default is false. Finding and replacing fonts and styles Property whatToFind find replace Data type string string string Notes In the format: "font" Name of font to find. Name of font to use as replacement.

  • 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

19
EXTENDING FIREWORKS
The Fireworks Object Model
Las
t
up
d
a
ted
12/8/2009
Find object
There are several ways to specify a Find object, depending on what you want to find and replace. Use the
whatToFind
property to specify the type of find operation, along with the properties that are associated with each legal value for
whatToFind
. These properties are listed in the following tables. Read-only properties are marked with a bullet (•).
Finding and replacing text
Finding and replacing fonts and styles
Method
Data Type
Notes
close()
none
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 is longer than 2048 characters.
readLineUTF8
string
Reads one line from the file that has been opened with UTF8
encoding.
write(textString)
string
Writes the specified string to the current File Reference object.
No end-of-line characters are appended; to include one, use
"\n"
.
writeUTF8
string
Writes text in UTF8 encoding when the file is opened in UTF8
encoding.
Property
Data type
Notes
whatToFind
string
In the format:
"text"
find
string
Text to find.
matchCase
Boolean
If set to
true
, the search is case-sensitive. Defaults to
false
.
numItemsReplaced
Integer
Number of replacements done in a file using Find and Replace.
regExp
Boolean
If set to
true
, the find and replace text is interpreted as a
regular expression. The default is
false
.
replace
string
Text to use as replacement text.
wholeWord
Boolean
If set to
true
, only whole words matching the search text are
found. The default is
false
.
Property
Data type
Notes
whatToFind
string
In the format:
"font"
find
string
Name of font to find.
replace
string
Name of font to use as replacement.