Skip to content

Property Group

PropertyGroup 

PropertyGroup(
    enabled: bool,
    match_name: str,
    name: str,
    is_effect: bool,
    properties: list[Property | PropertyGroup],
)

Bases: PropertyBase

The PropertyGroup object represents a group of properties. It can contain Property objects and other PropertyGroup objects. Property groups can be nested to provide a parent-child hierarchy, with a Layer object at the top (root) down to a single Property object, such as the mask feather of the third mask. To traverse the group hierarchy, use PropertyBase methods and attributes; see PropertyBase.propertyGroup(). For examples of how to access properties and property groups, see PropertyBase object.

Info

PropertyGroup is a subclass of PropertyBase. All methods and attributes of PropertyBase are available when working with PropertyGroup.

Info

PropertyGroup is a base class for MaskPropertyGroup. PropertyGroup attributes and methods are available when working with layer or mask groups.

See: https://ae-scripting.docsforadobe.dev/property/propertygroup/

Attributes

enabled 

enabled: bool

Corresponds to the setting of the eyeball icon.

is_effect 

is_effect: bool

When True, this property is an effect PropertyGroup.

match_name 

match_name: str

A special name for the property used to build unique naming paths. The match name is not displayed, but you can refer to it in scripts. Every property has a unique match-name identifier.

name 

name: str

Display name of the property.

properties 

properties: list[Property | PropertyGroup]

List of properties in this group.

Functions

active 

active() -> bool

Same as enabled.

get_property 

get_property(
    index: int | None = None, name: str | None = None
) -> Property | PropertyGroup

Find and return a child property of this group.

The property can be specified by either its index or name (match name or display name).

Parameters:

  • index
    (int | None, default: None ) –

    The index of the property to return.

  • name
    (str | None, default: None ) –

    The name of the property to return.

is_modified 

is_modified() -> bool

True if this property has been changed since its creation.