Skip to content

Commit 3085d73

Browse files
committed
ItemCollection: Improve legibility, add some crosslinks
1 parent 01f5761 commit 3085d73

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

docs/item/itemcollection.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44

55
#### Description
66

7-
The ItemCollection object represents a collection of items. The ItemCollection belonging to a [Project object](../general/project.md) contains all the Item objects for items in the project. The ItemCollection belonging to a FolderItem object contains all the Item objects for items in that folder.
7+
The ItemCollection object represents a collection of [Items](../item/item.md).
8+
9+
The ItemCollection belonging to a [Project object](../general/project.md) contains all the Item objects for [items in the project](../general/project.md#projectitems).
10+
11+
The ItemCollection belonging to a [FolderItem object](../item/folderitem.md) contains all the Item objects for [items in that folder](../item/folderitem.md#folderitemitems).
812

913
!!! info
1014
ItemCollection is a subclass of [Collection object](../other/collection.md). All methods and attributes of Collection, in addition to those listed below, are available when working with ItemCollection.
@@ -19,7 +23,11 @@ The ItemCollection object represents a collection of items. The ItemCollection b
1923

2024
#### Description
2125

22-
Creates a new composition. Creates and returns a new CompItem object and adds it to this collection. If the ItemCollection belongs to the project or the root folder, then the new item's `parentFolder` is the root folder. If the ItemCollection belongs to any other folder, the new item's `parentFolder` is that `FolderItem`.
26+
Creates and returns a new [CompItem object](../item/compitem.md) and adds it to this collection.
27+
28+
If the ItemCollection belongs to the project or the root folder, then the new item's [`parentFolder`](../item/item.md#itemparentfolder) is the [root folder](../general/project.md#projectrootfolder).
29+
30+
If the ItemCollection belongs to any other folder, the new item's `parentFolder` is that [FolderItem](../item/folderitem.md).
2331

2432
#### Parameters
2533

@@ -34,7 +42,7 @@ Creates a new composition. Creates and returns a new CompItem object and adds it
3442

3543
#### Returns
3644

37-
CompItem object.
45+
[CompItem object](../item/compitem.md)
3846

3947
---
4048

@@ -44,7 +52,11 @@ CompItem object.
4452

4553
#### Description
4654

47-
Creates a new folder. Creates and returns a new FolderItem object and adds it to this collection. If the ItemCollection belongs to the project or the root folder, then the new folder's `parentFolder` is the root folder. If the ItemCollection belongs to any other folder, the new folder's `parentFolder` is that `FolderItem`. To put items in the folder, set the [Item.parentFolder](item.md#itemparentfolder) attribute
55+
Creates and returns a new [FolderItem object](../item/folderitem.md) and adds it to this collection.
56+
57+
If the ItemCollection belongs to the [project](../general/project.md#projectitems) or the [root folder](../general/project.md#projectrootfolder), then the new folder's `parentFolder` is the root folder.
58+
59+
If the ItemCollection belongs to any other folder, the new folder's `parentFolder` is that FolderItem. To put items in the folder, set the [Item.parentFolder](item.md#itemparentfolder) attribute.
4860

4961
#### Parameters
5062

@@ -54,11 +66,11 @@ Creates a new folder. Creates and returns a new FolderItem object and adds it to
5466

5567
#### Returns
5668

57-
FolderItem object.
69+
[FolderItem object](../item/folderitem.md).
5870

5971
#### Example
6072

61-
This script creates a new FolderItem in the Project panel and moves compositions into it.
73+
This script creates a new [FolderItem](../item/folderitem.md) in the Project panel and moves compositions into it.
6274

6375
```javascript
6476
//create a new FolderItem in project, with name "comps"

0 commit comments

Comments
 (0)