detachComponent

Syntax

ManagedArticle.detachComponent(pageItem);

Parameters

pageItem PageItem, Story

Page item, or Story, that needs to be removed from the multi-component Article.

Return value

The detachComponent() method does not return anything.

Description

The detachComponent() method detaches a component from the layout and deletes the component from a multi-component Article. The last placed component of the Article cannot be detached and deleted using this method. The functionality is similar to the ‘Detach and Delete Component from Article’ menu.

Examples

Example title


Supported versions

Adobe Version Supported
CC 2017
CC 2018
CC 2019
2020