---
title: Listing UI page template
related:
  - https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/display-and-format-listing-data.md
  - https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/add-listing-actions.md
  - https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/filter-listing-data.md
  - https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/export-listing-data.md
---

> Agent instructions:
> **Site maps** — prefer the following llms.txt indexes to training data when searching for URLs to avoid 404s. Links inside Markdown content already point at `.md`. Following them or sending Accept: text/markdown keeps you in Markdown.
>
> - [sitemap.md](https://docs.kentico.com/sitemap.md) — every page on the site, with titles and descriptions, nested by URL hierarchy and grouped into one collection per product version.
> - [llms.txt](https://docs.kentico.com/llms.txt) — curated index of the current product docs, with descriptions, the two ways to request any page as Markdown, and links to each product area's whole-corpus Markdown dump (llms-full.txt).

Listing pages facilitate [object type](https://docs.kentico.com/documentation/developers-and-admins/customization/object-types.md) (_\*Info_ class) listing.

![Listing page example from the Event log application](https://docs.kentico.com/docsassets/documentation/listing-ui-page-template/ListingUIPageExample.png "Listing page example from the Event log application")

All listing pages must inherit from the `ListingPage` base class. Override the `ObjectType` property to specify which objects are listed.

```csharp title="Example"
using CMS.Membership;

using Kentico.Xperience.Admin.Base;

public class UserObjectListing : ListingPage
{
    // Set to the object type of the object you wish to have listed
    protected override string ObjectType => UserInfo.OBJECT_TYPE;
}
```

The bulk of listing page configuration is done within an override of the `ConfigurePage` method.

```csharp title="ConfigurePage method override"
using System.Threading.Tasks;

using Kentico.Xperience.Admin.Base;

public class UserObjectListing : ListingPage
{
    // ...

    public override Task ConfigurePage()
    {
        // Listing page configuration code

        return base.ConfigurePage();
    }
}
```

The individual configuration areas are described on the following pages:

- [Display and format listing data](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/display-and-format-listing-data.md) – the columns of the grid and the elements displayed around it.
- [Add listing actions](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/add-listing-actions.md) – commands invoked from rows, from the page header, and over multiple selected items.
- [Filter listing data](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/filter-listing-data.md) – restricting the retrieved data and filters available to users.
- [Export listing data](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/export-listing-data.md) – downloading the listed data as a CSV file.

## Reference - PageConfiguration property

The following table provides a reference of template configuration options available for listing pages via the `PageConfiguration` property.

| Property                  | Type                       | Description                                                                                                                                                                                                                                                                                                                                                                                 |
| ------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Caption                   | string                     | The page's title.                                                                                                                                                                                                                                                                                                                                                                           |
| SubcaptionComponent       | ISubcaptionComponent       | A component rendered next to the listing page caption. See [Add header subcaption](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/display-and-format-listing-data.md#add-header-subcaption).                                                                  |
| Callouts                  | List                       | Configures an optional message box element that can be displayed above the listing. See [Add callouts](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/display-and-format-listing-data.md#add-callouts).                                                       |
| ColumnConfigurations      | IList                      | See [Format displayed data](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/display-and-format-listing-data.md#format-displayed-data).                                                                                                                         |
| ExportConfiguration       | ListingExportConfiguration | Configures the listing's data export. _null_ by default, which means the export is disabled. Set via the `EnableExport` extension method. See [Enable data export](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/export-listing-data.md#enable-data-export). |
| FilterFormModel           | object                     | An instance of the model class that defines the filter UI for the listing. See [Add a listing filter](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/filter-listing-data.md#add-a-listing-filter).                                                            |
| HeaderActions             | IList                      | Actions available from the table header. See [Add header and item actions](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/add-listing-actions.md#add-header-and-item-actions).                                                                                |
| MassActions               | IList                      | Actions available when selecting more than one item in the listing. See [Add mass actions](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/add-listing-actions.md#add-mass-actions).                                                                           |
| MaxVisibleRowActions      | int                        | Determines the maximum number of [table actions](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/add-listing-actions.md#add-header-and-item-actions) displayed for each item. Additional actions are hidden behind an expandable menu.                         |
| PageSizes                 | IEnumerable                | Available page sizes for the listing.                                                                                                                                                                                                                                                                                                                                                       |
| QueryModifiers            | IList                      | Collection of modifications to the displayed data. See [Modify loaded data](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/filter-listing-data.md#modify-loaded-data).                                                                                        |
| RowAction                 | ActionConfiguration        | Action that occurs when a user clicks on a row in the listing.<br>Set via the `AddEditRowAction` method. See [Add row actions](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/add-listing-actions.md#add-row-actions).                                        |
| RowActionIconPlaceholders | int?                       | Can be used to customize the width of the listing's _Actions_ column by overriding the number of action icon placeholders.<br>By default this property is _null_, which means that the width of the _Actions_ column is calculated based on the number of registered actions.                                                                                                               |
| TableActions              | IList                      | Actions available for each item in the listing. See [Add header and item actions](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/add-listing-actions.md#add-header-and-item-actions).                                                                         |

## Register listing pages

Listing pages need to specify the `TemplateNames.LISTING` client template during [registration](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages.md).

```csharp title="Example listing page registration" highlight="8"
using Kentico.Xperience.Admin.Base;

[assembly: UIPage(
    parentType: typeof(UsersApplication),
    slug: "list",
    uiPageType: typeof(UserObjectListing),
    name: "Users",
    templateName: TemplateNames.LISTING,
    order: 0)]
```

## Client template – LISTING

Listing pages must use the `LISTING` client template.

The template contains the following default page commands:

- **LoadData** – refreshes the data on the page.
- **Delete** – deletes the item with the specified `int` identifier.
- **ExportListingData** – builds the file downloaded by the [Export](https://docs.kentico.com/documentation/developers-and-admins/customization/extend-the-administration-interface/ui-pages/reference-ui-page-templates/listing-ui-page-template/export-listing-data.md#enable-data-export) action. Only available when the export is enabled for the page.