Adobe 38039927 Extended User Guide - Page 20

File Reference object

Page 20 highlights

ADOBE FIREWORKS CS3 16 Extending Guide Method open(docname, bWrite) Data type string, Boolean rename(docname, newPlainFilename) string, string setFilename(docname, newPlainFilename) string, string swap(docname1, docname2) string, string Notes The first argument must be expressed as file://URL. Opens the specified file for reading or writing. If the second argument is true, the file opens for writing; otherwise it opens for reading. If the file cannot be opened, returns null; otherwise, returns a File Reference object. The docname argument is a file path or a file URL to the file that you want to rename. The newPlainFilename argument is the new name to assign to the file. The rename method returns a URL path of the newly renamed file if successful; otherwise Fireworks returns null. The first argument must be expressed as file://URL. Returns 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(). Each argument must be expressed as a file://URL. Swaps the contents of the two specified files, so that each file contains the contents of the other file. Only files (not directories) can be swapped, and both files must reside on the same drive. Returns true if the swap is successful; false otherwise. File Reference object The File Reference object is used to refer to a specific open file. The following table lists the methods of the File Reference object, along with their data types and, where appropriate, acceptable values and notes. Method close() readline() write(textString) Data Type none none 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. Writes the specified string to the current File Reference object. No end-of-line characters are appended; to include one, use "\n".

  • 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

ADOBE FIREWORKS CS3
Extending Guide
16
File Reference object
The File Reference object is used to refer to a specific open file. The following table lists the methods of the File
Reference object, along with their data types and, where appropriate, acceptable values and notes.
open(docname, bWrite)
string, Boolean
The first argument must be expressed as
file://URL
. Opens the specified file for reading or
writing. If the second argument is
true
, the file
opens for writing; otherwise it opens for reading.
If the file cannot be opened, returns
null
;
otherwise, returns a File Reference object.
rename(docname,
newPlainFilename)
string, string
The
docname
argument is a file path or a file
URL to the file that you want to rename.
The
newPlainFilename
argument is the
new name to assign to the file.
The
rename
method returns a URL path of the
newly renamed file if successful; otherwise Fire-
works returns
null
.
setFilename(docname,
newPlainFilename)
string, string
The first argument must be expressed as
file://URL
. Returns a file URL with
docname
replaced by
newPlainFilename
. For
example,
Files.setFile-
name("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 the two specified files, so
that each file contains the contents of the other
file. Only files (not directories) can be swapped,
and both files must reside on the same drive.
Returns
true
if the swap is successful;
false
otherwise.
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 char-
acter(s) are not included in the string. Returns
null
if end-of-file is reached or if the line is longer than
2048 characters.
write(textString)
string
Writes the specified string to the current File Refer-
ence object. No end-of-line characters are appended;
to include one, use
"\n"
.
Method
Data type
Notes