Folder

FolderItem ¶

FolderItem(
    comment: str,
    id: int,
    label: Label,
    name: str,
    parent_folder: FolderItem | None,
    type_name: str,
    items: list[Item] = list(),
)

Bases: Item

The FolderItem object corresponds to a folder in your Project panel. It can contain various types of items (footage, compositions, solids) as well as other folders.

See: https://ae-scripting.docsforadobe.dev/item/folderitem/

Attributes¶

comment ¶

comment: str

The item comment.

id ¶

id: int

The item unique identifier.

is_composition ¶

is_composition: bool

True if the item is a composition.

is_folder ¶

is_folder: bool

True if the item is a folder.

is_footage ¶

is_footage: bool

True if the item is a footage.

items ¶

items: list[Item] = field(default_factory=list)

The items in this folder. Contains only the top-level items in the folder.

label ¶

label: Label

The label color. Colors are represented by their number (0 for None, or 1 to 16 for one of the preset colors in the Labels preferences).

name ¶

name: str

The name of the item, as shown in the Project panel.

parent_folder ¶

parent_folder: FolderItem | None = field(repr=False)

The parent folder of this item. None for the root folder.

type_name ¶

type_name: str

A user-readable name for the item type ("Folder", "Footage" or "Composition"). These names are application locale-dependent, meaning that they are different depending on the application's UI language.