Hide Listing And Stop Execution
Audience:
Low-code EngineersSkill Prerequisites:
Actions,Listings
Hides a Listing module on the page, then ends execution. No actions after it run. Use it from a form or a listing to close a listing that you opened with Show Listing And Stop Execution or Show Listing And Continue Execution.
It only works on listings with Display Mode set to In Popup or Manual. A popup listing is closed. A manual listing is hidden.
| Action | What happens after the listing is hidden |
|---|---|
| Hide Listing And Stop Execution | No further actions run. |
| Hide Listing And Continue Execution | The listing is hidden right away and the next actions keep running. |
Typical Use Cases
- Close a listing popup from a "Close" or "Cancel" button
- Hide search results when the user clears a search form
- End a button's actions by hiding a listing the user no longer needs
Don't use it to
- Hide a listing and keep running actions. Use Hide Listing And Continue Execution instead.
- Hide a listing that is always visible. Set its Display Mode to Manual, or use its Show Conditionally setting instead.
- Hide a listing from an API endpoint. It's not available there.
Related Actions
| Action Name | Description |
|---|---|
| Hide Listing And Continue Execution | Hides the listing the same way, then keeps running actions. |
| Show Listing And Stop Execution | Shows or opens the listing and ends execution. |
| Show Listing And Continue Execution | Shows or opens the listing and keeps running actions. |
| Refresh Listing | Reloads the data of a listing. |
Input Parameter Reference
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| Select Module | The Listing module to hide. Pick it from the list, or use a token or expression that gives the module ID or its GUID. | Yes | empty | Yes |
How it works
The action sends a small script to the browser. The script checks the listing's Display Mode:
| Display Mode | What happens |
|---|---|
| Initially Visible | Nothing. The listing stays on the page. |
| In Popup | The popup is closed. |
| Manual | The listing is hidden. It stays on the page and can be shown again. |
See Display Mode.
Considerations
- Put it last. Actions after this one don't run. Save the data first, then hide the listing.
- Same page only. The listing must be on the page the user is looking at. If it isn't, nothing is hidden and the browser console shows an error.
- The value must be a module. If Select Module isn't a number or a GUID, the action fails with
Could not determine ModuleId to execute the action. - Refresh shows it again. In the current listing views, Refresh Listing makes a hidden manual listing visible again.
- Not in APIs, workflows or scheduled tasks. The action runs JavaScript in the browser, so it's only available in forms and listings.
- From JavaScript. You can do the same with
dnnsf.api.actionGrid.hideGridOrPopup(1234), where1234is the listing module ID. - Conditions. To hide the listing only in some cases, give it a condition, for example
"[Keyword]" == "". See Common Parameters.
Examples
To understand how to use the below examples, please see Running Examples.
1. Hide the search results when the form is cleared
Add this action to a "Clear" button of a search form. It hides the Listing module 1234, which has Display Mode set to Manual, and nothing else runs.
{
"Title": "Hide Listing And Stop Execution",
"ActionType": "HideAG",
"Description": "Hide the search results",
"Parameters": {
"ModuleId": "1234"
}
}
Revised 09/27/2026