General Documentation

• Introduction
• Page
  • Value Management
  • Snippets
  • Values
  • Enumerations
• Snippet Item
• Block
• List View
• Data
• Site Search
• Form
• Site Map
• Menu
• Breadcrumb
• Login
• Login Status
• Password Reset
• Language Switcher

The List View module lets content editors build Item queries with a variety of filters and then supply a custom format for display the results. Underneath, the List View module leverages the CMS Item search engine.

Some examples of List Views are:

• Displaying the most recent blog posts
• Displaying on articles within a certain time period
• Displaying items based on common attributes such as created user
• Displaying items that contain a specific value

A List View Item contains the following configurable sections:

• Data Source
• Templates
• Page Options

Data Source

The List View requires a data source be specified. There are two supported sources of data.

Query

Users can build the query the List View will use to retrieve items in the CMS instance.

To build the query, click the "open Query Builder" link button.

Filters are made up of the following pieces:

• Logical Operator - If there are more than 1 filter defined, the expression can matched using the keywords "And", "Or", "Not", "And Not", "Or Not".
• Filter type
  • Item Field - static fields that exist on each CMS Item
  • Property - custom defined properties assigned to CMS Items. Learn more about how Properties work.
  • Index Value - specific values stored in each CMS Item. Learn more about how Value Paths and Index Values work inside Items.
• Operator - How the filter type should be evaluated for a match. Options are "Equals", "Does Not Equal", "Greater Than", "Greater Than Or Equal To", "Less Than", "Less Than Or Equal To", "Like"
• Value - The value that the expression should match. Depending on the filter type selected, either inputs are displayed to receive the specific value or special selectors to assist in selecting CMS entities.
  • If available, a value can be set to NULL
  • If available, the value can be pulled from a query string. If enabled, a key to indicate the query string parameter to pull from is required. This is useful when the filter should be dynamic.

Once all filters are defined, sorting can be defined by selecting an Item field and a direction. Multiple sorts can be added.

Data Items

CMS Data Items can be used as a data source. By selecting a specific Data Item, it's data structure and containing values are used.

Templates

Querying is the first step in letting the List View know how to retrieve results. Templates are used to display these results. Do not confuse a List View's Template with CMS Layout Templates. 

Below are the following templates that can be specified. Each template type can either be supplied inline or be pulled from a Razor "asset view" file. If "From asset view" is selected, specify the path in the Media Manager the Razor file exists.

Layout Template

This template defines the overall template that List Item Template, Alternating List Item Template and Pager will be inserted into. Use the following two tokens:

• {# ListItems } - represents where List Items will be rendered.
• {# Pager } - represents where the Pager control will be rendered. 

List Item Template

This template defines how each result returned from the Query is displayed. Click the "Available Place Holders" link button to view the available tokens that can be used to display the result's details.

Alternating List Item Template

Similar to the List Item Template, the Alternating List Item Template, if specified, will be used on alternating loop iterations of a Query's results.

Empty Result Template

This template is used instead of the Layout and Item Template should the Query yield no results.

Pager Options

The results of the Query are limited to 100 items at a time. To help a web site visitor in navigating the pages of results, the List View will auto generate pagination links.

These are the available options:

• Records per page - 100 is the maximum.
• Pager Parameters Prefix - This is the query string key the List View will use to read the current page the web site visitor is on.
• Previous Text - Text of the link button to navigate to the previous page
• Next Text - Text of the link button to navigate to the next page
• Number of Links to Show - The number of links that show page numbers.