Modulo List

Il modulo List permette di gestire entità di tipo item mostrando gli element in una lista.

Per attivare una sezione con modulo List vanno configurati i settaggi nella relativa sezione specificando il tipo di elemento DataWeb che definisce l'item.

Il modulo List supporta le azioni personalizzate sia sul singolo elemento che sulla filtratura.

Il modulo può essere utilizzato con la sola configurazione in DataWeb ma, se serve, può essere personalizzato in ogni sua funzione impostando una classe ereditata da quella base ModuleList e sovrascrivendo i medodi interessati. La nuova classe viene impostata nei relativi settaggi in DataWeb.

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using System.Threading;
using Microsoft.Extensions.DependencyInjection;
using DataWeb.Structure;
using DataWeb.Structure.Modules;
using DataWeb.Identity;
using DataWeb.Data;

namespace App.DataWeb.Structure.Modules
{
    public class ModuleProductList(Section section, NavigationContext navigationContext, IServiceProvider serviceProvider) : ModuleList(section, navigationContext, serviceProvider)
    {
        private readonly IContextActionService contextActionService = serviceProvider.GetService<IContextActionService>();

        public override async Task<List<ContextAction>> GetActionsAsync(CancellationToken cancellationToken = default)
        {
            var actions = await base.GetActionsAsync(cancellationToken);

            actions.Add(contextActionService.GetRemoteAction("Notify status", "FilteredItemsNotify", ContextActionType.Notification, context: "FilteredItems", isConfirmRequired: true, isReloadAfterProcess: true, isSaveItemBeforeProcess: true));
            actions.Add(contextActionService.GetRemoteAction("Notify status item", "SelectedItemsNotify", ContextActionType.Tool, context: "SelectedItems"));
            actions.Add(contextActionService.GetRemoteAction("Set product status", "SelectedItemsSetProductStatus", ContextActionType.Dialog, context: "SelectedItems", dialogFormName: "Form_ActionProductStatus", isConfirmRequired: true, isReloadAfterProcess: true));

            return actions;
        }

        public override async Task<ContextAction.Result> ProcessActionAsync(ContextAction action, IUser user, List<string> itemIdMasters = null, List<Form.ProvidedValue> controlValues = null, NavigationContext navigationContext = null, CancellationToken cancellationToken = default)
        {
            var result = await base.ProcessActionAsync(action, user, itemIdMasters, controlValues, navigationContext, cancellationToken);

            switch (action.Name)
            {
                case "FilteredItemsNotify":
                case "SelectedItemsNotify":
                    result = NotifyStatus();
                    break;
                case "SelectedItemsSetProductStatus":
                    result = new ContextAction.Result { IsValid = true };
                    break;
            }

            return result;
        }

        public ContextAction.Result NotifyStatus()
        {
            var result = new ContextAction.Result { IsValid = true };
            return result;
        }
    }
}

In questo esempio stiamo integrando azioni personalizzate sia sugli item che sulla filtratura.

Questa tabella può essere usata come riferimento per identificare le aree della classe base ModuleList che possono essere personalizzate creando una classe derivata.

Il metodo GetContextItemsAsync può essere utilizzato nei vari contesti per recuperare rapidamente sia gli item filtrati che quelli selezionati (specificando gli IdMaster degli item coinvolti tramite itemIds). Ad esempio:

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

            var step = navigationContext.Steps.Last();

            switch (action.Name)
            {
                case "FilteredItemsExport":
                    var filteredContextItems = (await GetContextItemsAsync(cancellationToken: cancellationToken)).ContextItems;

                    result = new ContextAction.Result { IsValid = true, Stream = await ProcessExportAsync(filteredContextItems, cancellationToken), FileName = string.Format("{0}.xlsx", step.Section.Title), ContentType = "application/vnd.ms-excel" };
                    break;
                case "SelectedItemsExport":
                    if (itemIds == null || itemIds.Count == 0)
                    {
                        return new ContextAction.Result { IsValid = false, Error = new Validation.ValidationError { Name = "ActionName", Message = "items are required" } };
                    }

                    var selectedContextItems = (await GetContextItemsAsync(itemIdMasters: itemIds, cancellationToken: cancellationToken)).ContextItems;

                    result = new ContextAction.Result { IsValid = true, Stream = await ProcessExportAsync(selectedContextItems, cancellationToken), FileName = string.Format("{0}.xlsx", step.Section.Title), ContentType = "application/vnd.ms-excel" };
                    break;
            }

            return result;
        }