Class ModuleList

Inheritance

object

Module

ModuleList

Inherited Members

Module.section

Module.navigationContext

Module.serviceProvider

Module.ValidateAsync(Item, Dictionary<string, object>, CancellationToken)

Module.SaveAsync(Item, Dictionary<string, object>, CancellationToken)

Module.GetProvidedValues(Dictionary<string, object>)

Module.GetSectionNotificationCountAsync(CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DataWeb.Structure.Modules

Assembly: DataWeb.Core.dll

Syntax

public class ModuleList : Module

Constructors

ModuleList(Section, NavigationContext, IServiceProvider)

Declaration

public ModuleList(Section section, NavigationContext navigationContext, IServiceProvider serviceProvider)

Parameters

Type	Name	Description
Section	section
NavigationContext	navigationContext
IServiceProvider	serviceProvider

Methods

CloneAsync(Item, Item, CancellationToken)

Clones the provided item's module data to a new item.

Declaration

public override Task CloneAsync(Item item, Item itemCloned, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Item	item	The original Item to clone from.
Item	itemCloned	The new Item to clone to.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task that represents the asynchronous clone operation.

Overrides

Module.CloneAsync(Item, Item, CancellationToken)

GetActionsAsync(CancellationToken)

Gets the module actions.

Declaration

public override Task<List<ContextAction>> GetActionsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<List<ContextAction>>

Overrides

Module.GetActionsAsync(CancellationToken)

GetContextItemsAsync(bool, List<string>, CancellationToken)

Declaration

public virtual Task<ModuleList.ContextItemResult> GetContextItemsAsync(bool isPagination = false, List<string> itemIdMasters = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool	isPagination
List<string>	itemIdMasters
CancellationToken	cancellationToken

Returns

Type	Description
Task<ModuleList.ContextItemResult>

GetDataAsync(IEnumerable<UserSetting>, CancellationToken)

Declaration

public virtual Task<ModuleList.ListData> GetDataAsync(IEnumerable<UserSetting> userSettings, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IEnumerable<UserSetting>	userSettings
CancellationToken	cancellationToken

Returns

Type	Description
Task<ModuleList.ListData>

GetDeferredDataAsync(ItemsParams, IEnumerable<UserSetting>, CancellationToken)

Declaration

public virtual Task<IEnumerable<ModuleList.DeferredItem>> GetDeferredDataAsync(ModuleList.ItemsParams itemsParams, IEnumerable<UserSetting> userSettings, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ModuleList.ItemsParams	itemsParams
IEnumerable<UserSetting>	userSettings
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<ModuleList.DeferredItem>>

GetSearchSuggestionsAsync(SearchSuggestionFilter, IEnumerable<UserSetting>, CancellationToken)

Declaration

public virtual Task<IEnumerable<string>> GetSearchSuggestionsAsync(ModuleList.SearchSuggestionFilter suggestionFilter, IEnumerable<UserSetting> userSettings, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ModuleList.SearchSuggestionFilter	suggestionFilter
IEnumerable<UserSetting>	userSettings
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<string>>

IsCompletedAsync(Item, Section, CancellationToken)

Determines whether the provided item is completed for the current section.

Declaration

public override Task<bool> IsCompletedAsync(Item item, Section currentSection, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Item	item	The Item being checked.
Section	currentSection	The current Section being displayed.
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>	A task that represents the asynchronous check operation. The result is a boolean indicating whether the item is completed.

Overrides

Module.IsCompletedAsync(Item, Section, CancellationToken)

ProcessActionAsync(ContextAction, IUser, List<string>, List<ProvidedValue>, NavigationContext, CancellationToken)

Declaration

public override Task<ContextAction.Result> ProcessActionAsync(ContextAction action, IUser user, List<string> itemIds = null, List<Form.ProvidedValue> controlValues = null, NavigationContext navigationContext = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ContextAction	action
IUser	user
List<string>	itemIds
List<Form.ProvidedValue>	controlValues
NavigationContext	navigationContext
CancellationToken	cancellationToken

Returns

Type	Description
Task<ContextAction.Result>

Overrides

Module.ProcessActionAsync(ContextAction, IUser, List<string>, List<Form.ProvidedValue>, NavigationContext, CancellationToken)

ProcessExportAsync(IEnumerable<ContextItem>, CancellationToken)

Declaration

public virtual Task<Stream> ProcessExportAsync(IEnumerable<ContextItem> contextItems, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IEnumerable<ContextItem>	contextItems
CancellationToken	cancellationToken

Returns

Type	Description
Task<Stream>

ProcessOnItemCloneAsync(Item, Item, Navigation, CancellationToken)

Declaration

public virtual Task ProcessOnItemCloneAsync(Item item, Item itemSource, Navigation itemNavigation, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Item	item
Item	itemSource
Navigation	itemNavigation
CancellationToken	cancellationToken

Returns

Type	Description
Task

ProcessOnItemDeleteAsync(Item, Navigation, CancellationToken)

Declaration

public virtual Task ProcessOnItemDeleteAsync(Item item, Navigation itemNavigation, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Item	item
Navigation	itemNavigation
CancellationToken	cancellationToken

Returns

Type	Description
Task

ProcessOnItemMoveAsync(Item, Navigation, CancellationToken)

Declaration

public virtual Task ProcessOnItemMoveAsync(Item item, Navigation itemNavigation, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Item	item
Navigation	itemNavigation
CancellationToken	cancellationToken

Returns

Type	Description
Task

ProcessOnItemSetStatusAsync(Item, ItemStatus, Navigation, CancellationToken)

Declaration

public virtual Task ProcessOnItemSetStatusAsync(Item item, ItemStatus previousStatus, Navigation itemNavigation, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Item	item
ItemStatus	previousStatus
Navigation	itemNavigation
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetLayoutAsync(LayoutUpdate, CancellationToken)

Declaration

public virtual Task SetLayoutAsync(ModuleList.LayoutUpdate layoutUpdate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ModuleList.LayoutUpdate	layoutUpdate
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetOrderByAsync(OrderByUpdate, IEnumerable<UserSetting>, CancellationToken)

Declaration

public virtual Task SetOrderByAsync(ModuleList.OrderByUpdate orderByUpdate, IEnumerable<UserSetting> userSettings, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ModuleList.OrderByUpdate	orderByUpdate
IEnumerable<UserSetting>	userSettings
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetPageIndexAsync(PageIndexUpdate, CancellationToken)

Declaration

public virtual Task SetPageIndexAsync(ModuleList.PageIndexUpdate pageIndexUpdate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ModuleList.PageIndexUpdate	pageIndexUpdate
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetSearchAsync(SearchUpdate, CancellationToken)

Declaration

public virtual Task SetSearchAsync(ModuleList.SearchUpdate searchUpdate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ModuleList.SearchUpdate	searchUpdate
CancellationToken	cancellationToken

Returns

Type	Description
Task