Class NamedItemList

Namespace

Dynamicweb.Content.Items

Assembly

Dynamicweb.dll

NamedItemList connects an ItemList to a something (a Page, an Area, ...)

public class NamedItemList : DbObject

Inheritance

object

DbObject

NamedItemList

Inherited Members

DbObject._id

DbObject._tableName

DbObject._keyField

DbObject.Connection

DbObject.Transaction

DbObject.ID

DbObject.IsNew

DbObject.Delete()

DbObject.Load(int)

DbObject.Save()

DbObject.ExecuteDbObject<T>(CommandBuilder)

DbObject.ExecuteList<T>(string)

DbObject.ExecuteList<T>(CommandBuilder)

DbObject.ExecuteList<TCollection, T>(string)

DbObject.ExecuteList<TCollection, T>(CommandBuilder)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NamedItemList()

public NamedItemList()

Properties

ItemList

Gets or sets the item list.

public ItemList ItemList { get; }

Property Value

ItemList

ItemListId

Gets or sets the id of the item list.

public int ItemListId { get; set; }

Property Value

int

Name

Gets or sets the name of the named item list.

public string Name { get; set; }

Property Value

string

SourceId

Gets or sets the id of the owner.

public int SourceId { get; set; }

Property Value

int

SourceType

Gets or sets the type of the owner(a Page, an Area, an Item ...).

public string SourceType { get; set; }

Property Value

string

Methods

Add(Item, string, Page)

Add an item to a named item list

public static NamedItemList Add(Item item, string listName, Page page)

Parameters

item Item

The item

listName string

List name for new item

page Page

Page with list name

Returns

NamedItemList

Add(Item, string, Page, int)

Add an item to a named item list

public static NamedItemList Add(Item item, string listName, Page page, int sortIndex)

Parameters

item Item

The item

listName string

List name for new item

page Page

Page with list name

sortIndex int

Index of item in list

Returns

NamedItemList

Create(string, string, ListSourceType, int)

Create a new named list with all required properties

public static NamedItemList Create(string name, string itemType, NamedItemList.ListSourceType sourceType, int sourceId)

Parameters

name string

itemType string

sourceType NamedItemList.ListSourceType

sourceId int

Returns

NamedItemList

Delete(int)

Deletes the named list

public override void Delete(int id)

Parameters

id int

Fill(IDataReader)

Fills object properties with data from the given IDataReader object.

public override void Fill(IDataReader reader)

Parameters

reader IDataReader

Reader to read data from.

FillRow(DataRow)

Fills the given DataRow object with object state values.

protected override void FillRow(DataRow row)

Parameters

row DataRow

Row to write data into.

GetListById(int)

Gets named item list by ID

public static NamedItemList GetListById(int listId)

Parameters

listId int

The item list id

Returns

NamedItemList

GetListByName(string, ListSourceType, int)

Gets named item lists by source

public static NamedItemList GetListByName(string name, NamedItemList.ListSourceType sourceType, int sourceId)

Parameters

name string

sourceType NamedItemList.ListSourceType

The source type

sourceId int

The source id

Returns

NamedItemList

GetListsByArea(int)

Gets named item lists by area

public static IEnumerable<NamedItemList> GetListsByArea(int areaId)

Parameters

areaId int

The area id

Returns

IEnumerable<NamedItemList>

GetListsBySource(ListSourceType, int)

Gets named item lists by source

public static IEnumerable<NamedItemList> GetListsBySource(NamedItemList.ListSourceType sourceType, int sourceId)

Parameters

sourceType NamedItemList.ListSourceType

The source type

sourceId int

The source id

Returns

IEnumerable<NamedItemList>

GetNamedItemListByID(int)

[Obsolete("Use GetListById instead")]
public static NamedItemList GetNamedItemListByID(int listID)

Parameters

listID int

Returns

NamedItemList

GetNamedItemListByListId(int)

Gets named item lists by his list Id

public static NamedItemList GetNamedItemListByListId(int listId)

Parameters

listId int

The list id

Returns

NamedItemList

GetNamedItemListByName(string, ListSourceType, int)

[Obsolete("Use GetListByName instead")]
public static NamedItemList GetNamedItemListByName(string name, NamedItemList.ListSourceType sourceType, int sourceID)

Parameters

name string

sourceType NamedItemList.ListSourceType

sourceID int

Returns

NamedItemList

GetNamedItemListsByArea(int)

[Obsolete("Use GetListsByArea instead")]
public static IEnumerable<NamedItemList> GetNamedItemListsByArea(int areadId)

Parameters

areadId int

Returns

IEnumerable<NamedItemList>

GetNamedItemListsBySource(ListSourceType, int)

[Obsolete("Use GetListsBySource instead")]
public static IEnumerable<NamedItemList> GetNamedItemListsBySource(NamedItemList.ListSourceType sourceType, int sourceID)

Parameters

sourceType NamedItemList.ListSourceType

sourceID int

Returns

IEnumerable<NamedItemList>

GetNamedItemListsBySourceType(ListSourceType)

Gets named item lists by source type

public static IEnumerable<NamedItemList> GetNamedItemListsBySourceType(NamedItemList.ListSourceType sourceType)

Parameters

sourceType NamedItemList.ListSourceType

The source type

Returns

IEnumerable<NamedItemList>

Save(string, string, ListSourceType, int)

[Obsolete("Use Create instead")]
public void Save(string name, string itemType, NamedItemList.ListSourceType sourceType, int sourceID)

Parameters

name string

itemType string

sourceType NamedItemList.ListSourceType

sourceID int