Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

closeContainerItem(containerItemID, options)

Updated on July 20, 2021

Closes a container item.

Returns

A promise containing the order in which the remaining container items were accessed.

Parameters

NameTypeDescriptionRequired
containerItemIDstringThe container item that must be closed.
optionsobjectThe object containing additional information required to close the container item.

For example, the skipDirtyCheck property decides if the confirm dialog box (asking if the container item can be closed without saving the changes) should be displayed.

  • If skipDirtyCheck is true, the confirm dialog box is not displayed.
  • If skipDirtyCheck is false, the confirm dialog box is displayed if the container item is dirty.

Usage example

In this example, the API closes the container item with the ID app/primary_4. The confirm dialog box is not displayed.

PCore.getContainerUtils().closeContainerItem("app/primary_4",{skipDirtyCheck:true});

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us