Delete lists

Sitefinity CMS allows you to delete lists through the Lists API.

When deleting a list, you must perform the following:

  1. Get the list.
    First, you get the list corresponding to the specified ID.
    For more information about querying lists, see For developers: Query lists and For developers: Find lists.
  2. Delete the list.
    After you get the list, you delete it.
  3. Save the list.
    Finally, you must save the changes.

To delete a list you can use the Native API or the Fluent API.

Delete a list by its ID

The following examples delete a list by its ID:

Native API

C#
using System;
using System.Linq;
using Telerik.Sitefinity.Lists.Model;
using Telerik.Sitefinity.Modules.Lists;

namespace SitefinityWebApp
{
   public class DeleteListByIDNativeAPI
   {
       public void DeleteListNativeAPI(Guid listId)
       {
           ListsManager listsManager = ListsManager.GetManager();

           // Get the list
           List list = listsManager.GetLists().Where(l => l.Id == listId).FirstOrDefault();

           if (list != null)
           {
               // Mark the item to be deleted
               listsManager.DeleteList(list);

               // Save the changes
               listsManager.SaveChanges();
           }
       }

   }
}

First, you initialize the ListsManager. Then, you get the list using GetLists and filtering based on the Id property. To delete the list, you call the DeleteList method. Finally, you save the changes.

Fluent API

C#
using System;
using Telerik.Sitefinity;

namespace SitefinityWebApp
{
   public class DeleteListByIDFluentAPI
   {
       public void DeleteListFluentAPI(Guid listId)
       {
           int count = 0;
           App.WorkWith().Lists().Where(l => l.Id == listId).Count(out count);

           if (count > 0)
           {
               App.WorkWith().List(listId).Delete().SaveChanges();
           }
       }

   }
}

First, you initialize the plural facade of the list using App.WorkWith().Lists(). Then, you filter based on the Id property to assure that the list exists. To get the list, you use the singular facade. To delete the list, you use the Delete method of the facade. Finally, you save the changes.

**NOTE:**If there is no list with the specified ID, List(listId) throws an exception of type ItemNotFoundException.

Want to learn more?
Enhance your Sitefinity skills by enrolling in free training sessions. Become Sitefinity certified through Progress Education Community to strengthen your professional credentials.
This Article Contains
New to Sitefinity?