Adobe 12040118 Using Help - Page 97

Item object, Description, Attributes, Methods, Example

Page 97 highlights

Help Using Help Reference Back 97 Type Boolean; read/write. Item object app.project.item(index) app.project.items[index] Description The Item object represents an item that can appear in the Project window. FootageItem, CompItem, and FolderItem are all types of Item. Note that numbering of the index for item starts at 1, not 0. Attributes Attributes name comment id parentFolder selected typeName Methods Reference Description see "Item name attribute" on page 98 name of the object as shown in the Project window see "Item comment attribute" on page 98 string that holds a comment see "Item id attribute" on page 98 unique integer ID for this item see "Item parentFolder attribute" on page 98 parent folder of this item see "Item selected attribute" on page 99 true if this item is currently selected see "Item typeName attribute" on page 99 string corresponding to the type of item Method remove() Reference Description see "Item remove() method" on page 99 deletes the item from the project Example The following example will get the second item from the project and check that the typeName of that item is "Folder". Then it will remove from that folder any top-level item that is a Solid, but only if it is not currently selected. The example will also check to make sure that, for each item in the folder, the parentFolder is properly set to be the correct folder. var myFolder = app.project.item(2); if (myFolder.typeName != "Folder" ) { alert("error: second item is not a folder"); } else { var numInFolder = myFolder.numItems; // Always run loops backwards when deleting things: for(i = numInFolder; i >= 1; i--) { var curItem = myFolder.item(i); if ( curItem.parentFolder != myFolder) { Using Help Back 97

  • 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

U
sing H
elp
B
ack
97
Help
Reference
U
sing H
elp
B
ack
97
Type
Boolean; read/write.
Item object
app.project.item(index)
app.project.items[index]
Description
The Item object represents an item that can appear in the Project window. FootageItem, CompItem, and
FolderItem are all types of Item.
Note that numbering of the index for item starts at 1, not 0.
Attributes
Methods
Example
The following example will get the second item from the project and check that the typeName of that item is
"Folder". Then it will remove from that folder any top-level item that is a Solid, but only if it is not currently
selected. The example will also check to make sure that, for each item in the folder, the parentFolder is properly
set to be the correct folder.
var myFolder = app.project.item(2);
if (myFolder.typeName != "Folder" ) {
alert("error: second item is not a folder");
}
else {
var numInFolder = myFolder.numItems;
// Always run loops backwards when deleting things:
for(i = numInFolder; i >= 1; i--) {
var curItem = myFolder.item(i);
if ( curItem.parentFolder != myFolder) {
Attributes
Reference
Description
name
see “Item name attribute” on page 98
name of the object as shown in the Project
window
comment
see “Item comment attribute” on
page 98
string that holds a comment
id
see “Item id attribute” on page 98
unique integer ID for this item
parentFolder
see “Item parentFolder attribute” on
page 98
parent folder of this item
selected
see “Item selected attribute” on page 99
true if this item is currently selected
typeName
see “Item typeName attribute” on
page 99
string corresponding to the type of item
Method
Reference
Description
remove()
see “Item remove() method” on page 99
deletes the item from the project