Query list items

Sitefinity CMS allows you to query for a specific list item by its ID. To search for specific list items based on any other property or criteria, see For developers: Find list items.

NOTE: The code examples below work with the ID of the master version of the item and return the live version of the item. For more information about other scenarios, see For developers: Query master and live versions.

Query a single list item

When querying the live version of a specific list item by the ID of its master version, you must perform the following:

  1. Get the list item.
    First, get an instance of the master version of the list item that corresponds to the specified ID.
  2. Get the live version.
    The instance that corresponds to the ID argument is the master version of the list item. You can get the live version explicitly.

    NOTE: The live version is used only when displaying the list item in a front-end scenario. To modify the list item, consider using the master version. To transfer the changes to the live version, publish the master version.

  3. Return the list item.
    Return the list item. If an item with the specified ID does not exist, or if it has no live version, you return null.

The following examples query the live version of a list item by the ID of its master version.

Native API

First, you get an instance of the ListsManager class. You get the specified list item by querying all items and filtering the collection by the ID of the list item. If the item exists, you get its live version. If no live version exists (i.e. the list item has not been published), null is returned. Finally, you return the list item.

To find the list item, you can also use the GetListItem method passing masterListItemId:

NOTE: Calling GetListItem(masterListItemId) throws an exception of type ItemNotFoundException, if there is no list item with the specified Id.

Fluent API

First, you use the plural facade of the list item to assure that the item with the specified Id exists. Then, you use the GetLive method of the singular facade to get the instance of the live version. Finally, you return the list item.

Query all list items

Native API

To query all list items, use the following code sample::

Was this article helpful?

Next article

Find list items