Class ModuleListEdit

Inheritance

object

Module

ModuleListEdit

ModuleResourceListEdit

ModuleSubscriberListEdit

ModuleTemplateListEdit

Inherited Members

Module.section

Module.navigationContext

Module.serviceProvider

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

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

Module.IsCompletedAsync(Item, Section, CancellationToken)

Module.CloneAsync(Item, Item, 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 ModuleListEdit : Module

Constructors

ModuleListEdit(Section, NavigationContext, IServiceProvider)

Declaration

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

Parameters

Type	Name	Description
Section	section
NavigationContext	navigationContext
IServiceProvider	serviceProvider

Methods

CloneItemAsync(ItemParams, CancellationToken)

Declaration

public virtual Task<ModuleListEdit.ItemResult> CloneItemAsync(ModuleListEdit.ItemParams itemParams, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ModuleListEdit.ItemParams	itemParams
CancellationToken	cancellationToken

Returns

Type	Description
Task<ModuleListEdit.ItemResult>

ConvertToListItem(BasicItem, IEnumerable<DataField>)

Declaration

public ModuleListEdit.ListItem ConvertToListItem(BasicItem basicItem, IEnumerable<ModuleListEdit.ListData.DataField> datafields)

Parameters

Type	Name	Description
BasicItem	basicItem
IEnumerable<ModuleListEdit.ListData.DataField>	datafields

Returns

Type	Description
ModuleListEdit.ListItem

DeleteItemsAsync(ItemsParams, CancellationToken)

Declaration

public virtual Task<ModuleListEdit.ItemResult> DeleteItemsAsync(ModuleListEdit.ItemsParams itemParams, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ModuleListEdit.ItemsParams	itemParams
CancellationToken	cancellationToken

Returns

Type	Description
Task<ModuleListEdit.ItemResult>

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)

GetBasicItemsAsync(bool, List<string>, CancellationToken)

Declaration

public virtual Task<ModuleListEdit.BasicItemResult> GetBasicItemsAsync(bool isPagination = false, List<string> itemIds = null, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ModuleListEdit.BasicItemResult>

GetDataAsync(IEnumerable<UserSetting>, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
IEnumerable<UserSetting>	userSettings
CancellationToken	cancellationToken

Returns

Type	Description
Task<ModuleListEdit.ListData>

GetDataFieldsAsync(CancellationToken)

Declaration

public virtual Task<IEnumerable<ModuleListEdit.ListData.DataField>> GetDataFieldsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<ModuleListEdit.ListData.DataField>>

GetDeferredDataAsync(ItemsParams, IEnumerable<UserSetting>, CancellationToken)

Declaration

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

Parameters

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

Returns

Type	Description
Task<IEnumerable<ModuleListEdit.ListItem>>

GetFormDataAsync(ItemParams, CancellationToken)

Declaration

public virtual Task<ModuleListEdit.FormData> GetFormDataAsync(ModuleListEdit.ItemParams itemParams, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ModuleListEdit.ItemParams	itemParams
CancellationToken	cancellationToken

Returns

Type	Description
Task<ModuleListEdit.FormData>

GetItemIsWrite(BasicItem)

Declaration

public virtual bool GetItemIsWrite(BasicItem basicItem)

Parameters

Type	Name	Description
BasicItem	basicItem

Returns

Type	Description
bool

GetListWidgets(CancellationToken)

Declaration

public virtual IEnumerable<ModuleListEdit.ListData.ListWidget> GetListWidgets(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
IEnumerable<ModuleListEdit.ListData.ListWidget>

GetSearchFiltersAsync(IEnumerable<DataField>, IEnumerable<UserSetting>, CancellationToken)

Declaration

public virtual Task<List<SearchInfo.SearchFilter>> GetSearchFiltersAsync(IEnumerable<ModuleListEdit.ListData.DataField> dataFields, IEnumerable<UserSetting> userSettings, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IEnumerable<ModuleListEdit.ListData.DataField>	dataFields
IEnumerable<UserSetting>	userSettings
CancellationToken	cancellationToken

Returns

Type	Description
Task<List<SearchInfo.SearchFilter>>

GetSearchSuggestionsAsync(SearchSuggestionFilter, IEnumerable<UserSetting>, CancellationToken)

Declaration

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

Parameters

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

Returns

Type	Description
Task<IEnumerable<string>>

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<BasicItem>, CancellationToken)

Declaration

public virtual Task<Stream> ProcessExportAsync(IEnumerable<BasicItem> basicItems, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IEnumerable<BasicItem>	basicItems
CancellationToken	cancellationToken

Returns

Type	Description
Task<Stream>

ProcessListWidgetsDeferredValuesAsync(List<ListItem>, IEnumerable<UserSetting>, CancellationToken)

Declaration

public virtual Task ProcessListWidgetsDeferredValuesAsync(List<ModuleListEdit.ListItem> items, IEnumerable<UserSetting> userSettings, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
List<ModuleListEdit.ListItem>	items
IEnumerable<UserSetting>	userSettings
CancellationToken	cancellationToken

Returns

Type	Description
Task

ProcessListWidgetsValues(IEnumerable<ListItem>, IEnumerable<UserSetting>)

Declaration

public virtual void ProcessListWidgetsValues(IEnumerable<ModuleListEdit.ListItem> items, IEnumerable<UserSetting> userSettings)

Parameters

Type	Name	Description
IEnumerable<ModuleListEdit.ListItem>	items
IEnumerable<UserSetting>	userSettings

ProcessOnSaveDataAsync(BasicItem, List<ProvidedValue>, CancellationToken)

Declaration

public virtual Task ProcessOnSaveDataAsync(BasicItem basicItem, List<Form.ProvidedValue> providedValues, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BasicItem	basicItem
List<Form.ProvidedValue>	providedValues
CancellationToken	cancellationToken

Returns

Type	Description
Task

SaveItemAsync(EditSave, CancellationToken)

Declaration

public virtual Task<ModuleListEdit.ItemResult> SaveItemAsync(ModuleListEdit.EditSave saveData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ModuleListEdit.EditSave	saveData
CancellationToken	cancellationToken

Returns

Type	Description
Task<ModuleListEdit.ItemResult>

SetOrderByAsync(OrderByUpdate, IEnumerable<UserSetting>, CancellationToken)

Declaration

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

Parameters

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

Returns

Type	Description
Task

SetPageIndexAsync(PageIndexUpdate, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
ModuleListEdit.PageIndexUpdate	pageIndexUpdate
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetSearchAsync(SearchUpdate, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
ModuleListEdit.SearchUpdate	searchUpdate
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetSearchFilterAsync(SearchFilter, object, object, IEnumerable<UserSetting>, CancellationToken)

Declaration

public Task SetSearchFilterAsync(SearchInfo.SearchFilter searchFilter, object firstValue, object secondValue, IEnumerable<UserSetting> userSettings, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SearchInfo.SearchFilter	searchFilter
object	firstValue
object	secondValue
IEnumerable<UserSetting>	userSettings
CancellationToken	cancellationToken

Returns

Type	Description
Task