Show Listing And Stop Execution

Audience: Low-code Engineers

Skill Prerequisites: Actions, Listings, JSON

Shows a Listing module on the page, or opens it in a popup, then ends execution. No actions after it run. Use it from a form or a listing to show a listing only when the user needs it.

It only works on listings with Display Mode set to In Popup or Manual. A popup listing opens in a popup. A manual listing appears on the page.

Action	What happens after the listing is shown
Show Listing And Stop Execution	No further actions run.
Show Listing And Continue Execution	The listing is shown right away and the next actions keep running.

Typical Use Cases

• Open a listing in a popup from a "View History" or "Browse" button
• Show search results only after the user clicks "Search"
• Show a listing with a clean slate, without the filters or paging left in the URL

Don't use it to

• Show a listing and keep running actions. Use Show Listing And Continue Execution instead.
• Let the user pick a row and copy its values into a form. Use Pick Item from Listing instead.
• Open a form in a popup. Use Open Form Popup And Stop Execution instead.
• Show a listing from an API endpoint. It's not available there.

Related Actions

Action Name	Description
Show Listing And Continue Execution	Shows the listing the same way, then keeps running actions.
Hide Listing And Stop Execution	Hides the listing or closes its popup, and ends execution.
Filter Listing	Changes the filters, sorting or paging of a listing on the same page.
Pick Item from Listing	Opens a listing in a popup to pick a row for a form.
Open Form Popup And Stop Execution	Opens a Form module in a popup.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Select Module	The Listing module to show. Pick it from the list, or use a token or expression that gives the module ID or its GUID.	Yes	empty	Yes
Clear Listing QueryString	Removes the listing's page, search, filters and sorting from the URL, so the listing starts from its defaults.	No	false	No
Listing Modal Settings	Options for the popup, as a JSON object, for example {"backdrop":"static"}. Only used when the listing opens in a popup. See the modal options for Bootstrap 3 and Bootstrap 5.	Yes	empty	No

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 is already on the page.
In Popup	The listing opens in a popup, with the Listing Modal Settings. The popup's width comes from the listing's Popup Width setting, or 75% if it's not set.
Manual	The listing appears on the page.

See Display Mode.

Considerations

• Put it last. Actions after this one don't run. Save the data first, then show the listing.
• Valid JSON only. If Listing Modal Settings isn't a valid JSON object, the action fails with Could not parse the Listing Modal Settings. Common options are backdrop (true, false or "static") and keyboard (false stops the Esc key from closing the popup).
• Clear Listing QueryString is broad. In the legacy listing views, it removes every URL parameter whose name contains the module ID, for example page1234. In the current views, it reloads the listing with no page, search, filters or sorting.
• Same page only. The listing must be on the page the user is looking at. If it isn't, nothing is shown 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.
• 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.showGridOrPopup(1234, {"backdrop":"static"}, false), where 1234 is the listing module ID.
• Conditions. To show the listing only in some cases, give it a condition, for example "[CustomerId]" != "". See Common Parameters.

Examples

tip

To understand how to use the below examples, please see Running Examples.

1. Open order history in a popup

Add this action to a "View History" button. It opens the Listing module 1234, which has Display Mode set to In Popup. Clicking outside the popup doesn't close it, and the listing starts without old filters.

{
    "Title": "Show Listing And Stop Execution",
    "ActionType": "ShowAG",
    "Description": "Open the order history popup",
    "Parameters": {
        "ModuleId": "1234",
        "ClearGridQueryString": true,
        "ModalSettings": "{\"backdrop\":\"static\"}"
    }
}

Revised 09/27/2026