Class List

Namespace

Dynamicweb.CoreUI.Lists

Assembly

Dynamicweb.CoreUI.dll

public class List : UiComponentBase

Inheritance

object

UiComponentBase

List

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComponentExtensions.GetAll<TComponent>(UiComponentBase)

ComponentExtensions.GetOrAddTab(UiComponentBase, string)

ComponentExtensions.Get<TComponent>(UiComponentBase)

ComponentExtensions.Has<TComponent>(UiComponentBase)

ComponentExtensions.TryGet<TComponent>(UiComponentBase, out TComponent?)

Constructors

List()

public List()

List(DataQueryBase?)

public List(DataQueryBase? query)

Parameters

query DataQueryBase

Properties

AddSecondaryAction

public ActionNode? AddSecondaryAction { get; set; }

Property Value

ActionNode

AllowMultiSelect

public bool AllowMultiSelect { get; set; }

Property Value

bool

AllowSorting

public bool AllowSorting { get; set; }

Property Value

bool

AllowViewModes

public bool AllowViewModes { get; set; }

Property Value

bool

AvailableViews

public IEnumerable<ListViewMapping> AvailableViews { get; set; }

Property Value

IEnumerable<ListViewMapping>

Columns

public SortedDictionary<int, Column> Columns { get; }

Property Value

SortedDictionary<int, Column>

CreateNewAction

public ActionNode? CreateNewAction { get; set; }

Property Value

ActionNode

FilterValue

public string FilterValue { get; }

Property Value

string

Filters

public IEnumerable<FilterBase> Filters { get; set; }

Property Value

IEnumerable<FilterBase>

Groups

public IEnumerable<ListItemGroup>? Groups { get; set; }

Property Value

IEnumerable<ListItemGroup>

Header

public string Header { get; set; }

Property Value

string

Items

public IEnumerable<IListItem> Items { get; set; }

Property Value

IEnumerable<IListItem>

ListScreenDefinition

public Type? ListScreenDefinition { get; set; }

Property Value

Type

ManageAction

public ActionNode? ManageAction { get; set; }

Property Value

ActionNode

NoDataText

public string NoDataText { get; set; }

Property Value

string

PagingCount

public int PagingCount { get; }

Property Value

int

PagingIndex

public int PagingIndex { get; set; }

Property Value

int

PagingSize

public int PagingSize { get; set; }

Property Value

int

PagingSizes

public IEnumerable<List.SizeInfo> PagingSizes { get; set; }

Property Value

IEnumerable<List.SizeInfo>

SearchValue

public string SearchValue { get; }

Property Value

string

ShowFiltering

public bool ShowFiltering { get; set; }

Property Value

bool

ShowHeader

public bool ShowHeader { get; set; }

Property Value

bool

ShowListItemActions

public bool ShowListItemActions { get; set; }

Property Value

bool

ShowPaging

public bool ShowPaging { get; set; }

Property Value

bool

ShowSearch

public bool ShowSearch { get; set; }

Property Value

bool

TotalCount

public int TotalCount { get; set; }

Property Value

int

ViewTypeName

public string ViewTypeName { get; set; }

Property Value

string

Methods

AddListContextAction(ActionNode)

public void AddListContextAction(ActionNode action)

Parameters

action ActionNode

FillList<TRowModel>(FillListOptions<TRowModel>)

public void FillList<TRowModel>(FillListOptions<TRowModel> options)

Parameters

options FillListOptions<TRowModel>

Type Parameters

TRowModel

FillList<TRowModel>(ListScreenConfiguration, DataListViewModel<TRowModel>?, IEnumerable<ListViewMapping>?, Func<string, TRowModel, Cell?>?, Func<TRowModel, ActionBase?>?, Func<TRowModel, IEnumerable<ActionGroup>?>?, Func<TRowModel, string>?, Func<TRowModel, bool>?, Func<TRowModel, bool>?, Func<TRowModel, string?>?, Func<IEnumerable<ListItemGroup>?>?)

public void FillList<TRowModel>(ListScreenConfiguration configuration, DataListViewModel<TRowModel>? listData, IEnumerable<ListViewMapping>? viewMappings, Func<string, TRowModel, Cell?>? GetCell = null, Func<TRowModel, ActionBase?>? GetListItemPrimaryAction = null, Func<TRowModel, IEnumerable<ActionGroup>?>? GetListItemContextActions = null, Func<TRowModel, string>? GetRowId = null, Func<TRowModel, bool>? GetRowSelected = null, Func<TRowModel, bool>? GetRowSelectable = null, Func<TRowModel, string?>? GetListItemGroupID = null, Func<IEnumerable<ListItemGroup>?>? GetListItemGroups = null)

Parameters

configuration ListScreenConfiguration

listData DataListViewModel<TRowModel>

viewMappings IEnumerable<ListViewMapping>

GetCell Func<string, TRowModel, Cell>

GetListItemPrimaryAction Func<TRowModel, ActionBase>

GetListItemContextActions Func<TRowModel, IEnumerable<ActionGroup>>

GetRowId Func<TRowModel, string>

GetRowSelected Func<TRowModel, bool>

GetRowSelectable Func<TRowModel, bool>

GetListItemGroupID Func<TRowModel, string>

GetListItemGroups Func<IEnumerable<ListItemGroup>>

Type Parameters

TRowModel

GetColumnSortDirection(Column)

public SortDirection? GetColumnSortDirection(Column column)

Parameters

column Column

Returns

SortDirection?

GetItemsByGroup(ListItemGroup)

public IEnumerable<IListItem> GetItemsByGroup(ListItemGroup group)

Parameters

group ListItemGroup

Returns

IEnumerable<IListItem>

GetListContextActions()

public virtual ICollection<ActionNode> GetListContextActions()

Returns

ICollection<ActionNode>

GetListViewSwitchAction(string)

public ActionBase GetListViewSwitchAction(string viewModeSettingsTypeName)

Parameters

viewModeSettingsTypeName string

Returns

ActionBase

GetSortOrderAction(Column)

public ActionBase? GetSortOrderAction(Column column)

Parameters

column Column

Returns

ActionBase

IsSortable(Column)

public bool IsSortable(Column column)

Parameters

column Column

Returns

bool

SetListConfiguration(ListScreenConfiguration)

public void SetListConfiguration(ListScreenConfiguration configuration)

Parameters

configuration ListScreenConfiguration