Class ListController

Inheritance

object

ListController

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Common.Lists

Assembly: DotNetNuke.dll

Syntax

public class ListController

Constructors

ListController()

Declaration

public ListController()

ListController(IEventLogger)

Declaration

public ListController(IEventLogger eventLogger)

Parameters

Type	Name	Description
IEventLogger	eventLogger

Fields

NonLocalizedLists

Declaration

[Obsolete("Deprecated in DotNetNuke 9.8.1. Use UnLocalizedLists instead. Scheduled removal in v11.0.0.")]
public readonly string[] NonLocalizedLists

Field Value

Type	Description
string[]

Properties

UnLocalizedLists

Declaration

public IReadOnlyCollection<string> UnLocalizedLists { get; }

Property Value

Type	Description
IReadOnlyCollection<string>

Methods

AddListEntry(ListEntryInfo)

Declaration

public int AddListEntry(ListEntryInfo listEntry)

Parameters

Type	Name	Description
ListEntryInfo	listEntry

Returns

Type	Description
int

DeleteList(ListInfo, bool)

Declaration

public void DeleteList(ListInfo list, bool includeChildren)

Parameters

Type	Name	Description
ListInfo	list
bool	includeChildren

DeleteList(string, string)

Declaration

public void DeleteList(string listName, string parentKey)

Parameters

Type	Name	Description
string	listName
string	parentKey

DeleteList(string, string, int)

Declaration

public void DeleteList(string listName, string parentKey, int portalId)

Parameters

Type	Name	Description
string	listName
string	parentKey
int	portalId

DeleteListEntryByID(int, bool)

Declaration

public void DeleteListEntryByID(int entryId, bool deleteChild)

Parameters

Type	Name	Description
int	entryId
bool	deleteChild

DeleteListEntryByListName(string, string, bool)

Declaration

public void DeleteListEntryByListName(string listName, string listValue, bool deleteChild)

Parameters

Type	Name	Description
string	listName
string	listValue
bool	deleteChild

GetListEntryInfo(int)

Declaration

public ListEntryInfo GetListEntryInfo(int entryId)

Parameters

Type	Name	Description
int	entryId

Returns

Type	Description
ListEntryInfo

GetListEntryInfo(string, int)

Declaration

public ListEntryInfo GetListEntryInfo(string listName, int entryId)

Parameters

Type	Name	Description
string	listName
int	entryId

Returns

Type	Description
ListEntryInfo

GetListEntryInfo(string, string)

Declaration

public ListEntryInfo GetListEntryInfo(string listName, string listValue)

Parameters

Type	Name	Description
string	listName
string	listValue

Returns

Type	Description
ListEntryInfo

GetListEntryInfoDictionary(string)

Declaration

public Dictionary<string, ListEntryInfo> GetListEntryInfoDictionary(string listName)

Parameters

Type	Name	Description
string	listName

Returns

Type	Description
Dictionary<string, ListEntryInfo>

GetListEntryInfoDictionary(string, string)

Declaration

public Dictionary<string, ListEntryInfo> GetListEntryInfoDictionary(string listName, string parentKey)

Parameters

Type	Name	Description
string	listName
string	parentKey

Returns

Type	Description
Dictionary<string, ListEntryInfo>

GetListEntryInfoDictionary(string, string, int)

Declaration

public Dictionary<string, ListEntryInfo> GetListEntryInfoDictionary(string listName, string parentKey, int portalId)

Parameters

Type	Name	Description
string	listName
string	parentKey
int	portalId

Returns

Type	Description
Dictionary<string, ListEntryInfo>

GetListEntryInfoItems(string)

Declaration

public IEnumerable<ListEntryInfo> GetListEntryInfoItems(string listName)

Parameters

Type	Name	Description
string	listName

Returns

Type	Description
IEnumerable<ListEntryInfo>

GetListEntryInfoItems(string, string)

Declaration

public IEnumerable<ListEntryInfo> GetListEntryInfoItems(string listName, string parentKey)

Parameters

Type	Name	Description
string	listName
string	parentKey

Returns

Type	Description
IEnumerable<ListEntryInfo>

GetListEntryInfoItems(string, string, int)

Declaration

public IEnumerable<ListEntryInfo> GetListEntryInfoItems(string listName, string parentKey, int portalId)

Parameters

Type	Name	Description
string	listName
string	parentKey
int	portalId

Returns

Type	Description
IEnumerable<ListEntryInfo>

GetListInfo(string)

Declaration

public ListInfo GetListInfo(string listName)

Parameters

Type	Name	Description
string	listName

Returns

Type	Description
ListInfo

GetListInfo(string, string)

Declaration

public ListInfo GetListInfo(string listName, string parentKey)

Parameters

Type	Name	Description
string	listName
string	parentKey

Returns

Type	Description
ListInfo

GetListInfo(string, string, int)

Declaration

public ListInfo GetListInfo(string listName, string parentKey, int portalId)

Parameters

Type	Name	Description
string	listName
string	parentKey
int	portalId

Returns

Type	Description
ListInfo

GetListInfoCollection()

Declaration

public ListInfoCollection GetListInfoCollection()

Returns

Type	Description
ListInfoCollection

GetListInfoCollection(string)

Declaration

public ListInfoCollection GetListInfoCollection(string listName)

Parameters

Type	Name	Description
string	listName

Returns

Type	Description
ListInfoCollection

GetListInfoCollection(string, string)

Declaration

public ListInfoCollection GetListInfoCollection(string listName, string parentKey)

Parameters

Type	Name	Description
string	listName
string	parentKey

Returns

Type	Description
ListInfoCollection

GetListInfoCollection(string, string, int)

Declaration

public ListInfoCollection GetListInfoCollection(string listName, string parentKey, int portalId)

Parameters

Type	Name	Description
string	listName
string	parentKey
int	portalId

Returns

Type	Description
ListInfoCollection

UpdateListEntry(ListEntryInfo)

Declaration

public void UpdateListEntry(ListEntryInfo listEntry)

Parameters

Type	Name	Description
ListEntryInfo	listEntry

UpdateListSortOrder(int, bool)

Declaration

public void UpdateListSortOrder(int entryID, bool moveUp)

Parameters

Type	Name	Description
int	entryID
bool	moveUp

Extension Methods

JsonExtensionsWeb.ToJson(object)