Class ModuleListEdit

Represents a module that handles list editing functionalities within a section.

Inheritance
object
Module
ModuleListEdit
ModuleResourceListEdit
ModuleSubscriberListEdit
ModuleTemplateListEdit
Inherited Members
Namespace: DataWeb.Structure.Modules
Assembly: DataWeb.Core.dll
Syntax
public class ModuleListEdit : Module
Remarks

This class provides methods for retrieving, processing, and saving data, as well as handling search, pagination, and export functionalities. It leverages various services such as user, form, list, and audit services to perform operations on data and user interactions.

Constructors

ModuleListEdit(Section, NavigationContext, IServiceProvider)

Represents a module that handles list editing functionalities within a section.

Declaration
public ModuleListEdit(Section section, NavigationContext navigationContext, IServiceProvider serviceProvider)
Parameters
Type Name Description
Section section
NavigationContext navigationContext
IServiceProvider serviceProvider
Remarks

This class provides methods for retrieving, processing, and saving data, as well as handling search, pagination, and export functionalities. It leverages various services such as user, form, list, and audit services to perform operations on data and user interactions.

Methods

CloneItemAsync(ItemParams, CancellationToken)

Asynchronously clones an item.

Declaration
public virtual Task<ModuleListEdit.ItemResult> CloneItemAsync(ModuleListEdit.ItemParams itemParams, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ModuleListEdit.ItemParams itemParams

The parameters for the item to clone.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<ModuleListEdit.ItemResult>

A task that represents the asynchronous operation. The task result contains the result of the clone operation.

ConvertToListItem(BasicItem, IEnumerable<DataField>)

Converts a basic item into a list item.

Declaration
public ModuleListEdit.ListItem ConvertToListItem(BasicItem basicItem, IEnumerable<ModuleListEdit.ListData.DataField> datafields)
Parameters
Type Name Description
BasicItem basicItem

The basic item to convert.
IEnumerable<ModuleListEdit.ListData.DataField> datafields

The data fields for the conversion.
Returns
Type Description
ModuleListEdit.ListItem

The converted list item.

DeleteItemsAsync(ItemsParams, CancellationToken)

Asynchronously deletes items.

Declaration
public virtual Task<ModuleListEdit.ItemResult> DeleteItemsAsync(ModuleListEdit.ItemsParams itemParams, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ModuleListEdit.ItemsParams itemParams

The parameters for the items to delete.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<ModuleListEdit.ItemResult>

A task that represents the asynchronous operation. The task result contains the result of the delete operation.

GetActionsAsync(CancellationToken)

Asynchronously retrieves actions for the context.

Declaration
public override Task<List<ContextAction>> GetActionsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<List<ContextAction>>

A task that represents the asynchronous operation. The task result contains the context actions.
Overrides

GetBasicItemsAsync(bool, List<string>, CancellationToken)

Asynchronously retrieves basic items.

Declaration
public virtual Task<ModuleListEdit.BasicItemResult> GetBasicItemsAsync(bool isPagination = true, List<string> itemIds = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool isPagination

Indicates whether pagination is applied.
List<string> itemIds

The IDs of the items to retrieve.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<ModuleListEdit.BasicItemResult>

A task that represents the asynchronous operation. The task result contains the basic items.

GetDataAsync(IEnumerable<UserSetting>, CancellationToken)

Asynchronously retrieves data for a list view.

Declaration
public virtual Task<ModuleListEdit.ListData> GetDataAsync(IEnumerable<UserSetting> userSettings, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IEnumerable<UserSetting> userSettings

The user settings used for the data.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<ModuleListEdit.ListData>

A task that represents the asynchronous operation. The task result contains the list data.

GetDataFieldsAsync(CancellationToken)

Asynchronously retrieves data fields for the list view.

Declaration
public virtual Task<IEnumerable<ModuleListEdit.ListData.DataField>> GetDataFieldsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<IEnumerable<ModuleListEdit.ListData.DataField>>

A task that represents the asynchronous operation. The task result contains the list data fields.

GetDeferredDataAsync(ItemsParams, IEnumerable<UserSetting>, CancellationToken)

Asynchronously retrieves deferred data for a list view.

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

The parameters for the items to retrieve.
IEnumerable<UserSetting> userSettings

The user settings used for the data.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<IEnumerable<ModuleListEdit.ListItem>>

A task that represents the asynchronous operation. The task result contains the deferred list items.

GetFormDataAsync(ItemParams, CancellationToken)

Asynchronously retrieves form data for an item.

Declaration
public virtual Task<ModuleListEdit.FormData> GetFormDataAsync(ModuleListEdit.ItemParams itemParams, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ModuleListEdit.ItemParams itemParams

The parameters for the item.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<ModuleListEdit.FormData>

A task that represents the asynchronous operation. The task result contains the form data.

GetItemIsWrite(BasicItem)

Determines if a basic item can be modified.

Declaration
public virtual bool GetItemIsWrite(BasicItem basicItem)
Parameters
Type Name Description
BasicItem basicItem

The basic item to check.
Returns
Type Description
bool

True if the item can be modified; otherwise, false.

GetListWidgets(CancellationToken)

Retrieves widgets for the list view.

Declaration
public virtual IEnumerable<ModuleListEdit.ListData.ListWidget> GetListWidgets(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
IEnumerable<ModuleListEdit.ListData.ListWidget>

The list widgets.

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

Asynchronously retrieves search filters.

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

The data fields for the search filters.
IEnumerable<UserSetting> userSettings

The user settings for the search filters.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<List<SearchInfo.SearchFilter>>

A task that represents the asynchronous operation. The task result contains the search filters.

GetSearchSuggestionsAsync(SearchSuggestionFilter, IEnumerable<UserSetting>, CancellationToken)

Asynchronously retrieves search suggestions.

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

The filter for search suggestions.
IEnumerable<UserSetting> userSettings

The user settings for the search suggestions.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<IEnumerable<string>>

A task that represents the asynchronous operation. The task result contains the search suggestions.

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

Asynchronously processes a context action.

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

The context action to process.
IUser user

The user performing the action.
List<string> itemIds

The IDs of the items for the action.
List<Form.ProvidedValue> controlValues

The control values for the action.
NavigationContext navigationContext

The navigation context for the action.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<ContextAction.Result>

A task that represents the asynchronous operation. The task result contains the result of the action processing.
Overrides

ProcessExportAsync(IEnumerable<BasicItem>, CancellationToken)

Asynchronously processes the export of basic items.

Declaration
public virtual Task<Stream> ProcessExportAsync(IEnumerable<BasicItem> basicItems, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IEnumerable<BasicItem> basicItems

The basic items to export.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<Stream>

A task that represents the asynchronous operation. The task result contains the export stream.

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

Asynchronously processes deferred values for list widgets.

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

The items to process.
IEnumerable<UserSetting> userSettings

The user settings for the processing.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task

A task that represents the asynchronous operation.

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

Processes the values of list widgets for the given items.

Declaration
public virtual void ProcessListWidgetsValues(IEnumerable<ModuleListEdit.ListItem> items, IEnumerable<UserSetting> userSettings)
Parameters
Type Name Description
IEnumerable<ModuleListEdit.ListItem> items

The items to process.
IEnumerable<UserSetting> userSettings

The user settings for the processing.

ProcessOnSaveDataAsync(BasicItem, List<ProvidedValue>, CancellationToken)

Processes additional data during the save operation.

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

The basic item being saved.
List<Form.ProvidedValue> providedValues

The provided values for the save operation.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task

A task that represents the asynchronous operation.

SaveItemAsync(EditSave, CancellationToken)

Asynchronously saves an item.

Declaration
public virtual Task<ModuleListEdit.ItemResult> SaveItemAsync(ModuleListEdit.EditSave saveData, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ModuleListEdit.EditSave saveData

The data to save.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task<ModuleListEdit.ItemResult>

A task that represents the asynchronous operation. The task result contains the result of the save operation.

SetOrderByAsync(OrderByUpdate, IEnumerable<UserSetting>, CancellationToken)

Asynchronously updates the order by configuration.

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

The order by update.
IEnumerable<UserSetting> userSettings

The user settings for the order by update.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task

A task that represents the asynchronous operation.

SetPageIndexAsync(PageIndexUpdate, CancellationToken)

Asynchronously updates the page index for pagination.

Declaration
public virtual Task SetPageIndexAsync(ModuleListEdit.PageIndexUpdate pageIndexUpdate, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ModuleListEdit.PageIndexUpdate pageIndexUpdate

The page index update.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task

A task that represents the asynchronous operation.

SetSearchAsync(SearchUpdate, CancellationToken)

Asynchronously sets the search configuration.

Declaration
public virtual Task SetSearchAsync(ModuleListEdit.SearchUpdate searchUpdate, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ModuleListEdit.SearchUpdate searchUpdate

The search configuration update.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task

A task that represents the asynchronous operation.

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

Asynchronously updates a search filter.

Declaration
public virtual Task SetSearchFilterAsync(SearchInfo.SearchFilter searchFilter, object firstValue, object secondValue, IEnumerable<UserSetting> userSettings, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SearchInfo.SearchFilter searchFilter

The search filter to update.
object firstValue

The first value for the filter.
object secondValue

The second value for the filter.
IEnumerable<UserSetting> userSettings

The user settings for the filter update.
CancellationToken cancellationToken

Token to cancel the operation.
Returns
Type Description
Task

A task that represents the asynchronous operation.