Class List

Represents a list of items.

Inheritance

object

List

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DataWeb.Data

Assembly: DataWeb.Core.dll

Syntax

public sealed class List

Remarks

Initializes a new instance of the List class.

Constructors

List(IListStore)

Represents a list of items.

Declaration

public List(IListStore listStore)

Parameters

Type	Name	Description
IListStore	listStore	The list store to use.

Remarks

Initializes a new instance of the List class.

Properties

IdMaster

Gets or sets the unique identifier.

Declaration

public string IdMaster { get; set; }

Property Value

Type	Description
string

Name

Gets or sets the name of the list.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Values

Gets or sets the values of the list.

Declaration

public List<List.ListItem> Values { get; set; }

Property Value

Type	Description
List<List.ListItem>

Methods

Init(ListData)

Initializes the list with the specified data.

Declaration

public void Init(ListData listData)

Parameters

Type	Name	Description
ListData	listData	The ListData to use.

InitAsync(string, string, CancellationToken)

Initializes the list with the specified name and culture.

Declaration

public Task InitAsync(string name, string culture = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The name of the list.
string	culture	The culture to use.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task that represents the asynchronous operation.

Exceptions

Type	Condition
Exception	Thrown when the name is not defined or the list is not valid.