From a97142e3d6978abfa9af601772ad952a8b8351ab Mon Sep 17 00:00:00 2001 From: Gustau Navarro Date: Wed, 6 Apr 2022 00:42:01 +0200 Subject: [PATCH] Add AfterChangeValue grid column event --- GridBlazor/Columns/GridColumnBase.cs | 8 + GridBlazor/GridBlazor.csproj | 2 +- GridBlazor/Pages/GridCreateComponent.razor.cs | 5 +- GridBlazor/Pages/GridUpdateComponent.razor.cs | 5 +- .../ColumnCollections/ColumnCollections.cs | 66 ++++++++ .../Pages/AfterChangeValue.razor | 71 +++++++++ .../Shared/NavMenu.razor | 5 + .../Pages/AfterChangeValue.razor | 142 ++++++++++++++++++ GridBlazorOData.Client/Shared/NavMenu.razor | 5 + .../ColumnCollections/ColumnCollections.cs | 67 +++++++++ .../Pages/AfterChangeValue.razor | 78 ++++++++++ GridBlazorServerSide/Shared/NavMenu.razor | 5 + .../ColumnCollections/ColumnCollections.cs | 67 +++++++++ .../Pages/AfterChangeValue.razor | 77 ++++++++++ GridBlazorStandalone/Shared/NavMenu.razor | 5 + GridCore/Columns/GridCoreColumnBase.cs | 8 + GridCore/GridCore.csproj | 2 +- GridMvc/GridMvc.csproj | 2 +- GridShared/Columns/IGridColumn.cs | 6 + GridShared/GridShared.csproj | 2 +- docs/blazor_client/Events.md | 29 ++++ docs/blazor_local/Events.md | 30 ++++ docs/blazor_odata/Events.md | 30 ++++ docs/blazor_server/Events.md | 30 ++++ docs/dotnetcore_blazor/Events.md | 30 ++++ 25 files changed, 771 insertions(+), 6 deletions(-) create mode 100644 GridBlazorClientSide.Client/Pages/AfterChangeValue.razor create mode 100644 GridBlazorOData.Client/Pages/AfterChangeValue.razor create mode 100644 GridBlazorServerSide/Pages/AfterChangeValue.razor create mode 100644 GridBlazorStandalone/Pages/AfterChangeValue.razor diff --git a/GridBlazor/Columns/GridColumnBase.cs b/GridBlazor/Columns/GridColumnBase.cs index 2165f2be..23ff7271 100644 --- a/GridBlazor/Columns/GridColumnBase.cs +++ b/GridBlazor/Columns/GridColumnBase.cs @@ -70,6 +70,8 @@ public abstract class GridColumnBase : GridStyledColumn, IGridColumn, IExp public Func CrudHidden { get; protected set; } = x => GridShared.Columns.CrudHidden.NONE; + public Func AfterChangeValue { get; set; } + public Func ReadOnlyOnCreate { get; protected set; } = x => false; public Func ReadOnlyOnUpdate { get; protected set; } = x => false; @@ -524,6 +526,12 @@ public IGridColumn SetCrudHidden(bool create, bool read, bool update, bool de return this; } + public IGridColumn SetAfterChangeValue(Func afterChangeValue) + { + AfterChangeValue = afterChangeValue; + return this; + } + public IGridColumn SetExcelHidden(bool? excelHidden) { ExcelHidden = excelHidden; diff --git a/GridBlazor/GridBlazor.csproj b/GridBlazor/GridBlazor.csproj index 70fee599..5b60403c 100644 --- a/GridBlazor/GridBlazor.csproj +++ b/GridBlazor/GridBlazor.csproj @@ -6,7 +6,7 @@ 8.0 True False - 3.2.4 + 3.2.5 GridBlazor Grid components for Blazor Grid components for Blazor diff --git a/GridBlazor/Pages/GridCreateComponent.razor.cs b/GridBlazor/Pages/GridCreateComponent.razor.cs index 26744cc5..a6a4bb0d 100644 --- a/GridBlazor/Pages/GridCreateComponent.razor.cs +++ b/GridBlazor/Pages/GridCreateComponent.razor.cs @@ -125,7 +125,7 @@ private void SetValue(object value, IGridColumn column) pi.SetValue(obj, value, null); } - private void ChangeValue(ChangeEventArgs e, IGridColumn column, string typeAttr = null) + private async Task ChangeValue(ChangeEventArgs e, IGridColumn column, string typeAttr = null) { if (string.IsNullOrWhiteSpace(e.Value.ToString())) { @@ -181,6 +181,9 @@ private void ChangeValue(ChangeEventArgs e, IGridColumn column, string typeAttr } } } + + if (((IGridColumn)column).AfterChangeValue != null) + await((IGridColumn)column).AfterChangeValue(Item, GridMode.Create); } private void OnFileChange(IGridColumn column, IFileListEntry[] files) diff --git a/GridBlazor/Pages/GridUpdateComponent.razor.cs b/GridBlazor/Pages/GridUpdateComponent.razor.cs index f6df4aeb..2b590daa 100644 --- a/GridBlazor/Pages/GridUpdateComponent.razor.cs +++ b/GridBlazor/Pages/GridUpdateComponent.razor.cs @@ -145,7 +145,7 @@ private void SetValue(object value, IGridColumn column) pi.SetValue(obj, value, null); } - private void ChangeValue(ChangeEventArgs e, IGridColumn column, string typeAttr = null) + private async Task ChangeValue(ChangeEventArgs e, IGridColumn column, string typeAttr = null) { if (string.IsNullOrWhiteSpace(e.Value.ToString())) { @@ -201,6 +201,9 @@ private void ChangeValue(ChangeEventArgs e, IGridColumn column, string typeAttr } } } + + if (((IGridColumn)column).AfterChangeValue != null) + await((IGridColumn)column).AfterChangeValue(Item, GridMode.Update); } private void OnFileChange(IGridColumn column, IFileListEntry[] files) diff --git a/GridBlazorClientSide.Client/ColumnCollections/ColumnCollections.cs b/GridBlazorClientSide.Client/ColumnCollections/ColumnCollections.cs index d73bad4c..1d7bffa8 100644 --- a/GridBlazorClientSide.Client/ColumnCollections/ColumnCollections.cs +++ b/GridBlazorClientSide.Client/ColumnCollections/ColumnCollections.cs @@ -572,6 +572,72 @@ public static Action, string, Func o.Customer.IsVip ? Strings.BoolTrueLabel : Strings.BoolFalseLabel).SetCrudHidden(true); }; + public static Action, Func, string> OrderColumnsWithCrudAfterChange + = (c, afterChangeCustomerID, path) => + { + /* Adding "OrderID" column: */ + c.Add(o => o.OrderID).SetPrimaryKey(true).Titled(SharedResource.Number).SetWidth(100); + + /* Adding "CustomerID" column: */ + c.Add(o => o.CustomerID, true).SetSelectField(true, o => o.Customer.CustomerID + " - " + o.Customer.CompanyName, o => path + $"api/SampleData/GetAllCustomers") + .SetAfterChangeValue(afterChangeCustomerID); + + /* Adding "EmployeeID" column: */ + c.Add(o => o.EmployeeID, true).SetSelectField(true, o => o.Employee.EmployeeID.ToString() + " - " + o.Employee.FirstName + " " + o.Employee.LastName, o => path + $"api/SampleData/GetAllEmployees"); + + /* Adding "ShipVia" column: */ + c.Add(o => o.ShipVia, true).SetSelectField(true, o => o.Shipper == null ? "" : o.Shipper.ShipperID.ToString() + " - " + o.Shipper.CompanyName, path + $"api/SampleData/GetAllShippers"); + + /* Adding "OrderDate" column: */ + c.Add(o => o.OrderDate, "OrderCustomDate").Titled(SharedResource.OrderCustomDate) + .Format("{0:yyyy-MM-dd}").SetWidth(120) + .SetCrudWidth(3); + + /* Adding "CompanyName" column: */ + c.Add(o => o.Customer.CompanyName).Titled(SharedResource.CompanyName) + .SetWidth(250).SetCrudHidden(true).SetReadOnlyOnUpdate(true); + + /* Adding "ContactName" column: */ + c.Add(o => o.Customer.ContactName).Titled(SharedResource.ContactName).SetCrudHidden(true); + + /* Adding "Freight" column: */ + c.Add(o => o.Freight) + .Titled(SharedResource.Freight) + .SetWidth(150) + .Format("{0:#,##0.00}"); + + /* Adding "Vip customer" column: */ + c.Add(o => o.Customer.IsVip).Titled(SharedResource.IsVip).SetWidth(90).Css("hidden-xs") //hide on phones + .RenderValueAs(o => o.Customer.IsVip ? Strings.BoolTrueLabel : Strings.BoolFalseLabel).SetCrudHidden(true); + + /* Adding hidden "RequiredDate" column: */ + c.Add(o => o.RequiredDate, true).Format("{0:yyyy-MM-dd}").SetCrudWidth(3); + + /* Adding hidden "ShippedDate" column: */ + c.Add(o => o.ShippedDate, true).Format("{0:yyyy-MM-dd}").SetCrudWidth(3); + + /* Adding hidden "ShipName" column: */ + c.Add(o => o.ShipName, true); + + /* Adding hidden "ShipAddress" column: */ + c.Add(o => o.ShipAddress, true); + + /* Adding hidden "ShipCity" column: */ + c.Add(o => o.ShipCity, true); + + /* Adding hidden "ShipPostalCode" column: */ + c.Add(o => o.ShipPostalCode, true); + + /* Adding hidden "ShipRegion" column: */ + c.Add(o => o.ShipRegion, true); + + /* Adding hidden "ShipCountry" column: */ + c.Add(o => o.ShipCountry, true); + + /* Adding not mapped column, that renders a component */ + c.Add(true).Titled("Images").RenderCrudComponentAs(); + }; + public static Action> OrderColumnsWithSubgrids = c => { /* Adding "OrderID" column: */ diff --git a/GridBlazorClientSide.Client/Pages/AfterChangeValue.razor b/GridBlazorClientSide.Client/Pages/AfterChangeValue.razor new file mode 100644 index 00000000..dac98380 --- /dev/null +++ b/GridBlazorClientSide.Client/Pages/AfterChangeValue.razor @@ -0,0 +1,71 @@ +@page "/afterchangevalue" +@using GridBlazorClientSide.Client.ColumnCollections +@using GridBlazorClientSide.Shared.Models +@using Microsoft.Extensions.Primitives +@using System.Globalization +@using System.Threading.Tasks +@inject NavigationManager NavigationManager +@inject HttpClient HttpClient +@inject ICrudDataService orderService + +

Grid Sample

+ +

+ This page contains a CRUD grid implementing an event to modify the OrderDate after the CustomerID is changed on the Create form +

+ +

+ This component demonstrates a GridBlazor client-side grid. For more information, please see: https://github.com/gustavnavar/Grid.Blazor +

+ +@if (_task.IsCompleted) +{ +
+
+ +
+
+} +else +{ +

Loading...

+} + +@code +{ + private CGrid _grid; + private Task _task; + + protected override async Task OnParametersSetAsync() + { + var locale = CultureInfo.CurrentCulture; + + var query = new QueryDictionary(); + string url = NavigationManager.BaseUri + "api/SampleData/OrderColumnsWithCrud"; + + Func afterChangeCustomerID = async (order, mode) => + { + if (mode == GridMode.Create) + { + order.OrderDate = DateTime.Now; + StateHasChanged(); + await Task.CompletedTask; + } + }; + + var client = new GridClient(HttpClient, url, query, false, "ordersGrid", c => + ColumnCollections.OrderColumnsWithCrudAfterChange(c, afterChangeCustomerID, NavigationManager.BaseUri), locale) + .Sortable() + .Filterable() + .SetStriped(true) + .Crud(true, orderService) + .WithMultipleFilters() + .WithGridItemsCount(); + + _grid = client.Grid; + + // Set new items to grid + _task = client.UpdateGrid(); + await _task; + } +} diff --git a/GridBlazorClientSide.Client/Shared/NavMenu.razor b/GridBlazorClientSide.Client/Shared/NavMenu.razor index 66c1c7a0..2ddd34e6 100644 --- a/GridBlazorClientSide.Client/Shared/NavMenu.razor +++ b/GridBlazorClientSide.Client/Shared/NavMenu.razor @@ -97,6 +97,11 @@ Header CRUD +
  • + + Change event + +
  • Page Size diff --git a/GridBlazorOData.Client/Pages/AfterChangeValue.razor b/GridBlazorOData.Client/Pages/AfterChangeValue.razor new file mode 100644 index 00000000..39cac8a2 --- /dev/null +++ b/GridBlazorOData.Client/Pages/AfterChangeValue.razor @@ -0,0 +1,142 @@ +@page "/afterchangevalue" +@using GridBlazor.Resources +@using GridShared.Columns +@using GridBlazorOData.Client.Resources +@using GridBlazorOData.Shared.Models +@using Microsoft.Extensions.Primitives +@using System.Globalization +@using System.Threading.Tasks +@inject NavigationManager NavigationManager +@inject HttpClient HttpClient + +

    Grid Sample

    + +

    + This page contains a CRUD grid implementing an event to modify the OrderDate after the CustomerID is changed on the Create form +

    + +

    + This component demonstrates a GridBlazor client-side grid with an OData back-end. For more information, please see: https://github.com/gustavnavar/Grid.Blazor +

    + +@if (_task.IsCompleted) +{ +
    +
    + +
    +
    +} +else +{ +

    Loading...

    +} + +@code +{ + private CGrid _grid; + private Task _task; + + protected override async Task OnParametersSetAsync() + { + var locale = CultureInfo.CurrentCulture; + + var query = new QueryDictionary(); + + Action, Func, string> columns = (c, afterChangeCustomerID, baseUri) => + { + c.Add(o => o.OrderID).SetPrimaryKey(true).Titled(SharedResource.Number).SetWidth(100); + c.Add(o => o.CustomerID, true).SetSelectField(true, o => o.Customer.CustomerID + " - " + o.Customer.CompanyName, o => GetAllCustomers(baseUri)).SetAfterChangeValue(afterChangeCustomerID); + c.Add(o => o.EmployeeID, true).SetSelectField(true, o => o.Employee.EmployeeID.ToString() + " - " + o.Employee.FirstName + " " + o.Employee.LastName, o => GetAllEmployees(baseUri)); + c.Add(o => o.ShipVia, true).SetSelectField(true, o => o.Shipper == null ? "" : o.Shipper.ShipperID.ToString() + " - " + o.Shipper.CompanyName, () => GetAllShippers(baseUri)); + c.Add(o => o.OrderDate, "OrderCustomDate").Titled(SharedResource.OrderCustomDate).Format("{0:yyyy-MM-dd}").SetWidth(120).SetCrudWidth(3); + c.Add(o => o.Customer.CompanyName).Titled(SharedResource.CompanyName).SetWidth(250).SetCrudHidden(true).SetReadOnlyOnUpdate(true); + c.Add(o => o.Customer.ContactName).Titled(SharedResource.ContactName).SetCrudHidden(true); + c.Add(o => o.Freight).Titled(SharedResource.Freight).SetWidth(150).Format("{0:#,##0.00}"); + c.Add(o => o.Customer.IsVip).Titled(SharedResource.IsVip).SetWidth(90).Css("hidden-xs").RenderValueAs(o => o.Customer.IsVip ? Strings.BoolTrueLabel : Strings.BoolFalseLabel).SetCrudHidden(true); + c.Add(o => o.RequiredDate, true).Format("{0:yyyy-MM-dd}").SetCrudWidth(3); + c.Add(o => o.ShippedDate, true).Format("{0:yyyy-MM-dd}").SetCrudWidth(3); + c.Add(o => o.ShipName, true); + c.Add(o => o.ShipAddress, true); + c.Add(o => o.ShipCity, true); + c.Add(o => o.ShipPostalCode, true); + c.Add(o => o.ShipRegion, true); + c.Add(o => o.ShipCountry, true); + c.Add(true).Titled("Images").RenderCrudComponentAs(); + }; + + Func afterChangeCustomerID = async (order, mode) => + { + if (mode == GridMode.Create) + { + order.OrderDate = DateTime.Now; + StateHasChanged(); + await Task.CompletedTask; + } + }; + + string url = NavigationManager.BaseUri + "odata/Orders"; + var client = new GridODataClient(HttpClient, url, query, false, "ordersGrid", + c => columns(c, afterChangeCustomerID, NavigationManager.BaseUri), 10, locale, new List { "Employee", "Shipper" }) + .Sortable() + .Filterable() + .SetStriped(true) + .ODataCrud(true) + .WithMultipleFilters() + .WithGridItemsCount(); + + _grid = client.Grid; + + // Set new items to grid + _task = client.UpdateGrid(); + await _task; + } + + Func>> GetAllCustomers = async (baseUri) => + { + string url = baseUri + $"odata/Customers?$select=CustomerID,CompanyName"; + ODataDTO response = await new HttpClient().GetFromJsonAsync>(url); + if (response == null || response.Value == null) + { + return new List(); + } + else + { + return response.Value + .Select(r => new SelectItem(r.CustomerID, r.CustomerID + " - " + r.CompanyName)) + .ToList(); + } + }; + + Func>> GetAllEmployees = async (baseUri) => + { + string url = baseUri + $"odata/Employees?$select=EmployeeID,FirstName,LastName"; + ODataDTO response = await new HttpClient().GetFromJsonAsync>(url); + if (response == null || response.Value == null) + { + return new List(); + } + else + { + return response.Value + .Select(r => new SelectItem(r.EmployeeID.ToString(), r.EmployeeID.ToString() + " - " + r.FirstName + " " + r.LastName)) + .ToList(); + } + }; + + Func>> GetAllShippers = async (baseUri) => + { + string url = baseUri + $"odata/Shippers?$select=ShipperID,CompanyName"; + ODataDTO response = await new HttpClient().GetFromJsonAsync>(url); + if (response == null || response.Value == null) + { + return new List(); + } + else + { + return response.Value + .Select(r => new SelectItem(r.ShipperID.ToString(), r.ShipperID.ToString() + " - " + r.CompanyName)) + .ToList(); + } + }; +} diff --git a/GridBlazorOData.Client/Shared/NavMenu.razor b/GridBlazorOData.Client/Shared/NavMenu.razor index 831c29fa..62cd6c33 100644 --- a/GridBlazorOData.Client/Shared/NavMenu.razor +++ b/GridBlazorOData.Client/Shared/NavMenu.razor @@ -92,6 +92,11 @@ Header CRUD
    • +
  • + + Change event + +
  • Page Size diff --git a/GridBlazorServerSide/ColumnCollections/ColumnCollections.cs b/GridBlazorServerSide/ColumnCollections/ColumnCollections.cs index ffc25636..fa6031fc 100644 --- a/GridBlazorServerSide/ColumnCollections/ColumnCollections.cs +++ b/GridBlazorServerSide/ColumnCollections/ColumnCollections.cs @@ -577,6 +577,73 @@ public static Action, IList>, ob .RenderValueAs(o => o.Customer.IsVip ? Strings.BoolTrueLabel : Strings.BoolFalseLabel).SetCrudHidden(true); }; + public static Action, Func>, + Func>, Func>, Func> + OrderColumnsWithCrudAfterChange = (c, f, g, h, afterChangeCustomerID) => + { + /* Adding "OrderID" column: */ + c.Add(o => o.OrderID).SetPrimaryKey(true).Titled(SharedResource.Number).SetWidth(100); + + /* Adding "CustomerID" column: */ + c.Add(o => o.CustomerID, true).SetSelectField(true, o => o.Customer.CustomerID + " - " + o.Customer.CompanyName, f).SetAfterChangeValue(afterChangeCustomerID); + + /* Adding "EmployeeID" column: */ + c.Add(o => o.EmployeeID, true).SetSelectField(true, o => o.Employee.EmployeeID.ToString() + " - " + o.Employee.FirstName + " " + o.Employee.LastName, g); + + /* Adding "ShipVia" column: */ + c.Add(o => o.ShipVia, true).SetSelectField(true, o => o.Shipper == null ? "" : o.Shipper.ShipperID.ToString() + " - " + o.Shipper.CompanyName, h); + + /* Adding "OrderDate" column: */ + c.Add(o => o.OrderDate, "OrderCustomDate").Titled(SharedResource.OrderCustomDate) + .Format("{0:yyyy-MM-dd}") + .SetWidth(120) + .SetCrudWidth(3); + + /* Adding "CompanyName" column: */ + c.Add(o => o.Customer.CompanyName).Titled(SharedResource.CompanyName) + .SetWidth(250).SetCrudHidden(true).SetReadOnlyOnUpdate(true); + + /* Adding "ContactName" column: */ + c.Add(o => o.Customer.ContactName).Titled(SharedResource.ContactName).SetCrudHidden(true); + + /* Adding "Freight" column: */ + c.Add(o => o.Freight) + .Titled(SharedResource.Freight) + .SetWidth(150) + .Format("{0:#,##0.00}"); + + /* Adding "Vip customer" column: */ + c.Add(o => o.Customer.IsVip).Titled(SharedResource.IsVip).SetWidth(90).Css("hidden-xs") //hide on phones + .RenderValueAs(o => o.Customer.IsVip ? Strings.BoolTrueLabel : Strings.BoolFalseLabel).SetCrudHidden(true); + + /* Adding hidden "RequiredDate" column: */ + c.Add(o => o.RequiredDate, true).Format("{0:yyyy-MM-dd}").SetCrudWidth(3); + + /* Adding hidden "ShippedDate" column: */ + c.Add(o => o.ShippedDate, true).Format("{0:yyyy-MM-dd}").SetCrudWidth(3); + + /* Adding hidden "ShipName" column: */ + c.Add(o => o.ShipName, true); + + /* Adding hidden "ShipAddress" column: */ + c.Add(o => o.ShipAddress, true); + + /* Adding hidden "ShipCity" column: */ + c.Add(o => o.ShipCity, true); + + /* Adding hidden "ShipPostalCode" column: */ + c.Add(o => o.ShipPostalCode, true); + + /* Adding hidden "ShipRegion" column: */ + c.Add(o => o.ShipRegion, true); + + /* Adding hidden "ShipCountry" column: */ + c.Add(o => o.ShipCountry, true); + + /* Adding not mapped column, that renders a component */ + c.Add(true).Titled("Images").RenderCrudComponentAs(); + }; + public static Action> OrderColumnsWithSubgrids = c => { /* Adding "OrderID" column: */ diff --git a/GridBlazorServerSide/Pages/AfterChangeValue.razor b/GridBlazorServerSide/Pages/AfterChangeValue.razor new file mode 100644 index 00000000..c677e331 --- /dev/null +++ b/GridBlazorServerSide/Pages/AfterChangeValue.razor @@ -0,0 +1,78 @@ +@page "/afterchangevalue" +@using GridBlazorServerSide.ColumnCollections +@using GridBlazorServerSide.Models +@using GridBlazorServerSide.Resources +@using GridBlazorServerSide.Services +@using Microsoft.Extensions.Primitives +@using System.Globalization +@using System.Threading.Tasks +@inject IOrderService orderService +@inject ICustomerService customerService +@inject IEmployeeService employeeService +@inject IShipperService shipperService + +

    Grid Sample

    + +

    + This page contains a CRUD grid implementing an event to modify the OrderDate after the CustomerID is changed on the Create form +

    + +

    + This component demonstrates a GridBlazor server-side grid. For more information, please see: https://github.com/gustavnavar/Grid.Blazor +

    + +@if (_task.IsCompleted) +{ +
    +
    + +
    +
    +} +else +{ +

    Loading...

    +} + +@code +{ + private CGrid _grid; + private Task _task; + + protected override async Task OnParametersSetAsync() + { + var locale = CultureInfo.CurrentCulture; + SharedResource.Culture = locale; + + var query = new QueryDictionary(); + + Func afterChangeCustomerID = async (order, mode) => + { + if (mode == GridMode.Create) + { + order.OrderDate = DateTime.Now; + StateHasChanged(); + await Task.CompletedTask; + } + }; + + Action> columns = c => ColumnCollections.OrderColumnsWithCrudAfterChange(c, + c => customerService.GetAllCustomers(), c => employeeService.GetAllEmployees(), shipperService.GetAllShippers, + afterChangeCustomerID); + + var client = new GridClient(q => orderService.GetOrdersGridRowsAsync(columns, q), + query, false, "ordersGrid", columns, locale) + .Sortable() + .Filterable() + .SetStriped(true) + .Crud(true, orderService) + .WithMultipleFilters() + .WithGridItemsCount(); + + _grid = client.Grid; + + // Set new items to grid + _task = client.UpdateGrid(); + await _task; + } +} diff --git a/GridBlazorServerSide/Shared/NavMenu.razor b/GridBlazorServerSide/Shared/NavMenu.razor index 66c1c7a0..2ddd34e6 100644 --- a/GridBlazorServerSide/Shared/NavMenu.razor +++ b/GridBlazorServerSide/Shared/NavMenu.razor @@ -97,6 +97,11 @@ Header CRUD
    • +
  • + + Change event + +
  • Page Size diff --git a/GridBlazorStandalone/ColumnCollections/ColumnCollections.cs b/GridBlazorStandalone/ColumnCollections/ColumnCollections.cs index 5838d39e..e043b11e 100644 --- a/GridBlazorStandalone/ColumnCollections/ColumnCollections.cs +++ b/GridBlazorStandalone/ColumnCollections/ColumnCollections.cs @@ -577,6 +577,73 @@ public static Action, IList>, ob .RenderValueAs(o => o.Customer.IsVip ? Strings.BoolTrueLabel : Strings.BoolFalseLabel).SetCrudHidden(true); }; + public static Action, Func>, + Func>, Func>, Func> + OrderColumnsWithCrudAfterChange = (c, f, g, h, afterChangeCustomerID) => + { + /* Adding "OrderID" column: */ + c.Add(o => o.OrderID).SetPrimaryKey(true, false).Titled(SharedResource.Number).SetWidth(100); + + /* Adding "CustomerID" column: */ + c.Add(o => o.CustomerID, true).SetSelectField(true, o => o.Customer.CustomerID + " - " + o.Customer.CompanyName, f).SetAfterChangeValue(afterChangeCustomerID); + + /* Adding "EmployeeID" column: */ + c.Add(o => o.EmployeeID, true).SetSelectField(true, o => o.Employee.EmployeeID.ToString() + " - " + o.Employee.FirstName + " " + o.Employee.LastName, g); + + /* Adding "ShipVia" column: */ + c.Add(o => o.ShipVia, true).SetSelectField(true, o => o.Shipper == null ? "" : o.Shipper.ShipperID.ToString() + " - " + o.Shipper.CompanyName, h); + + /* Adding "OrderDate" column: */ + c.Add(o => o.OrderDate, "OrderCustomDate").Titled(SharedResource.OrderCustomDate) + .Format("{0:yyyy-MM-dd}") + .SetWidth(120) + .SetCrudWidth(3); + + /* Adding "CompanyName" column: */ + c.Add(o => o.Customer.CompanyName).Titled(SharedResource.CompanyName) + .SetWidth(250).SetCrudHidden(true).SetReadOnlyOnUpdate(true); + + /* Adding "ContactName" column: */ + c.Add(o => o.Customer.ContactName).Titled(SharedResource.ContactName).SetCrudHidden(true); + + /* Adding "Freight" column: */ + c.Add(o => o.Freight) + .Titled(SharedResource.Freight) + .SetWidth(150) + .Format("{0:#,##0.00}"); + + /* Adding "Vip customer" column: */ + c.Add(o => o.Customer.IsVip).Titled(SharedResource.IsVip).SetWidth(90).Css("hidden-xs") //hide on phones + .RenderValueAs(o => o.Customer.IsVip ? Strings.BoolTrueLabel : Strings.BoolFalseLabel).SetCrudHidden(true); + + /* Adding hidden "RequiredDate" column: */ + c.Add(o => o.RequiredDate, true).Format("{0:yyyy-MM-dd}").SetCrudWidth(3); + + /* Adding hidden "ShippedDate" column: */ + c.Add(o => o.ShippedDate, true).Format("{0:yyyy-MM-dd}").SetCrudWidth(3); + + /* Adding hidden "ShipName" column: */ + c.Add(o => o.ShipName, true); + + /* Adding hidden "ShipAddress" column: */ + c.Add(o => o.ShipAddress, true); + + /* Adding hidden "ShipCity" column: */ + c.Add(o => o.ShipCity, true); + + /* Adding hidden "ShipPostalCode" column: */ + c.Add(o => o.ShipPostalCode, true); + + /* Adding hidden "ShipRegion" column: */ + c.Add(o => o.ShipRegion, true); + + /* Adding hidden "ShipCountry" column: */ + c.Add(o => o.ShipCountry, true); + + /* Adding not mapped column, that renders a component */ + c.Add(true).Titled("Images").RenderCrudComponentAs(); + }; + public static Action> OrderColumnsWithSubgrids = c => { /* Adding "OrderID" column: */ diff --git a/GridBlazorStandalone/Pages/AfterChangeValue.razor b/GridBlazorStandalone/Pages/AfterChangeValue.razor new file mode 100644 index 00000000..f9edda34 --- /dev/null +++ b/GridBlazorStandalone/Pages/AfterChangeValue.razor @@ -0,0 +1,77 @@ +@page "/afterchangevalue" +@using GridBlazorStandalone.ColumnCollections +@using GridBlazorStandalone.Models +@using GridBlazorStandalone.Services +@using Microsoft.Extensions.Primitives +@using System.Globalization +@using System.Threading.Tasks +@inject NavigationManager NavigationManager +@inject HttpClient HttpClient +@inject IOrderService orderService +@inject ICustomerService customerService +@inject IEmployeeService employeeService +@inject IShipperService shipperService + +

    Grid Sample

    + +

    + This page contains a CRUD grid implementing an event to modify the OrderDate after the CustomerID is changed on the Create form +

    + +

    + This component demonstrates an standalone GridBlazor client-side grid. For more information, please see: https://github.com/gustavnavar/Grid.Blazor +

    + +@if (_task.IsCompleted) +{ +
    +
    + +
    +
    +} +else +{ +

    Loading...

    +} + +@code +{ + private CGrid _grid; + private Task _task; + + protected override async Task OnParametersSetAsync() + { + var locale = CultureInfo.CurrentCulture; + + var query = new QueryDictionary(); + + Func afterChangeCustomerID = async (order, mode) => + { + if (mode == GridMode.Create) + { + order.OrderDate = DateTime.Now; + StateHasChanged(); + await Task.CompletedTask; + } + }; + + Action> columns = c => ColumnCollections.OrderColumnsWithCrudAfterChange(c, + c => customerService.GetAllCustomers(), c => employeeService.GetAllEmployees(), shipperService.GetAllShippers, + afterChangeCustomerID); + + var client = new GridClient(q => orderService.GetOrdersGridRows(columns, q), query, false, "ordersGrid", columns, locale) + .Sortable() + .Filterable() + .SetStriped(true) + .Crud(true, orderService) + .WithMultipleFilters() + .WithGridItemsCount(); + + _grid = client.Grid; + + // Set new items to grid + _task = client.UpdateGrid(); + await _task; + } +} diff --git a/GridBlazorStandalone/Shared/NavMenu.razor b/GridBlazorStandalone/Shared/NavMenu.razor index 66c1c7a0..2ddd34e6 100644 --- a/GridBlazorStandalone/Shared/NavMenu.razor +++ b/GridBlazorStandalone/Shared/NavMenu.razor @@ -97,6 +97,11 @@ Header CRUD
    • +
  • + + Change event + +
  • Page Size diff --git a/GridCore/Columns/GridCoreColumnBase.cs b/GridCore/Columns/GridCoreColumnBase.cs index bdc387aa..85ca9acb 100644 --- a/GridCore/Columns/GridCoreColumnBase.cs +++ b/GridCore/Columns/GridCoreColumnBase.cs @@ -71,6 +71,8 @@ public GridSortDirection? InitialDirection public Func CrudHidden { get; protected set; } = x => GridShared.Columns.CrudHidden.NONE; + public Func AfterChangeValue { get; set; } + public Func ReadOnlyOnCreate { get; protected set; } = x => false; public Func ReadOnlyOnUpdate { get; protected set; } = x => false; @@ -538,6 +540,12 @@ public IGridColumn SetCrudHidden(bool all) return SetCrudHidden(all, all, all, all); } + public IGridColumn SetAfterChangeValue(Func afterChangeValue) + { + AfterChangeValue = afterChangeValue; + return this; + } + public IGridColumn SetReadOnlyOnCreate(bool enabled) { ReadOnlyOnCreate = x => enabled; diff --git a/GridCore/GridCore.csproj b/GridCore/GridCore.csproj index f374e2b9..314f7fbc 100644 --- a/GridCore/GridCore.csproj +++ b/GridCore/GridCore.csproj @@ -7,7 +7,7 @@ False GridCore GridCore - 5.2.3 + 5.2.4 GridCore Grid core component Grid core component diff --git a/GridMvc/GridMvc.csproj b/GridMvc/GridMvc.csproj index 27e5a2ae..be84ec10 100644 --- a/GridMvc/GridMvc.csproj +++ b/GridMvc/GridMvc.csproj @@ -8,7 +8,7 @@ False GridMvc GridMvcCore - 5.2.3 + 5.2.4 GridMvc ASP.NET MVC Grid component ASP.NET MVC Grid component diff --git a/GridShared/Columns/IGridColumn.cs b/GridShared/Columns/IGridColumn.cs index db692506..bae3f476 100644 --- a/GridShared/Columns/IGridColumn.cs +++ b/GridShared/Columns/IGridColumn.cs @@ -25,6 +25,7 @@ public interface IGridColumn : IGridColumn, IColumn, ISortableColumn, { get; } Func>> SelectItemExpr { get; set; } Func CrudHidden { get; } + Func AfterChangeValue { get; set; } } public interface IGridColumn : ISortableColumn, IFilterableColumn @@ -350,6 +351,11 @@ IGridColumn RenderCrudComponentAs IGridColumn SetCrudHidden(bool all); + /// + /// Sets a function to be executed after the column value is changed (CRUD) + /// + IGridColumn SetAfterChangeValue(Func afterChangeValue); + /// /// Sets the column as hidden for excel export, /// overriding the default Hidden value (if not null) diff --git a/GridShared/GridShared.csproj b/GridShared/GridShared.csproj index 89540746..c5b5b338 100644 --- a/GridShared/GridShared.csproj +++ b/GridShared/GridShared.csproj @@ -3,7 +3,7 @@ netstandard2.1;net5.0;net6.0 8.0 - 5.2.2 + 5.2.4 GridShared Support library for GridBlazor and GridMvcCore component libraries Support library for GridBlazor and GridMvcCore component libraries diff --git a/docs/blazor_client/Events.md b/docs/blazor_client/Events.md index b0a4f539..f70ec213 100644 --- a/docs/blazor_client/Events.md +++ b/docs/blazor_client/Events.md @@ -215,6 +215,35 @@ Notice that all handlers must be async. In this sample ```OrderValidator``` is a class that validates the ```Order``` object to be modified. If it's a valid item the event returns ```true```. If the item is not valid the event writes an error on the form and returns ```false```. +## Grid column events + +Grid column provides an event to notify when a column is changed in the standard Create and Update forms. The supported event is: +- ```Func AfterChangeValue```: it's fired when the column value is changed + +This column event is configured using the ```SetAfterChangeValue``` of the ```GridColumn``` object. + +You can see here an example of the grid column definition where the method ```afterChangeCustomerID``` is fired when a new value of the ```CusotmerID``` is selected: + +```c# +c.Add(o => o.CustomerID) + .SetSelectField(true, o => o.Customer.CustomerID + " - " + o.Customer.CompanyName, o => path + $"api/SampleData/GetAllCustomers") + .SetAfterChangeValue(afterChangeCustomerID); +``` + +The fired method can do any change on the row. You can see here an example where the ```OrderDate``` field is modified only on the Create form: + +```c# +Func afterChangeCustomerID = async (order, mode) => +{ + if (mode == GridMode.Create) + { + order.OrderDate = DateTime.Now; + StateHasChanged(); + await Task.CompletedTask; + } +}; +``` + ## Default CRUD data annotations validation GridBlazor validates by default all data annotations defined with attributes on the the model. This validation happens for Create and Update standard forms. If you use custom CRUD forms this will depend on your code. diff --git a/docs/blazor_local/Events.md b/docs/blazor_local/Events.md index 8d231d2e..8bf5f477 100644 --- a/docs/blazor_local/Events.md +++ b/docs/blazor_local/Events.md @@ -212,6 +212,36 @@ Notice that all handlers must be async. In this sample ```OrderValidator``` is a class that validates the ```Order``` object to be modified. If it's a valid item the event returns ```true```. If the item is not valid the event writes an error on the form and returns ```false```. +## Grid column events + +Grid column provides an event to notify when a column is changed in the standard Create and Update forms. The supported event is: +- ```Func AfterChangeValue```: it's fired when the column value is changed + +This column event is configured using the ```SetAfterChangeValue``` of the ```GridColumn``` object. + +You can see here an example of the grid column definition where the method ```afterChangeCustomerID``` is fired when a new value of the ```CusotmerID``` is selected: + +```c# +c.Add(o => o.CustomerID) + .SetSelectField(true, o => o.Customer.CustomerID + " - " + o.Customer.CompanyName, f) + .SetAfterChangeValue(afterChangeCustomerID); +``` + +The fired method can do any change on the row. You can see here an example where the ```OrderDate``` field is modified only on the Create form: + +```c# +Func afterChangeCustomerID = async (order, mode) => +{ + if (mode == GridMode.Create) + { + order.OrderDate = DateTime.Now; + StateHasChanged(); + await Task.CompletedTask; + } +}; +``` + + ## Default CRUD data annotations validation GridBlazor validates by default all data annotations defined with attributes on the the model. This validation happens for Create and Update standard forms. If you use custom CRUD forms this will depend on your code. diff --git a/docs/blazor_odata/Events.md b/docs/blazor_odata/Events.md index dcf31031..7e7724ce 100644 --- a/docs/blazor_odata/Events.md +++ b/docs/blazor_odata/Events.md @@ -215,6 +215,36 @@ Notice that all handlers must be async. In this sample ```OrderValidator``` is a class that validates the ```Order``` object to be modified. If it's a valid item the event returns ```true```. If the item is not valid the event writes an error on the form and returns ```false```. +## Grid column events + +Grid column provides an event to notify when a column is changed in the standard Create and Update forms. The supported event is: +- ```Func AfterChangeValue```: it's fired when the column value is changed + +This column event is configured using the ```SetAfterChangeValue``` of the ```GridColumn``` object. + +You can see here an example of the grid column definition where the method ```afterChangeCustomerID``` is fired when a new value of the ```CusotmerID``` is selected: + +```c# +c.Add(o => o.CustomerID) + .SetSelectField(true, o => o.Customer.CustomerID + " - " + o.Customer.CompanyName, o => path + $"api/SampleData/GetAllCustomers") + .SetAfterChangeValue(afterChangeCustomerID); +``` + +The fired method can do any change on the row. You can see here an example where the ```OrderDate``` field is modified only on the Create form: + +```c# +Func afterChangeCustomerID = async (order, mode) => +{ + if (mode == GridMode.Create) + { + order.OrderDate = DateTime.Now; + StateHasChanged(); + await Task.CompletedTask; + } +}; +``` + + ## Default CRUD data annotations validation GridBlazor validates by default all data annotations defined with attributes on the the model. This validation happens for Create and Update standard forms. If you use custom CRUD forms this will depend on your code. diff --git a/docs/blazor_server/Events.md b/docs/blazor_server/Events.md index 8b1f8037..62ce0dc0 100644 --- a/docs/blazor_server/Events.md +++ b/docs/blazor_server/Events.md @@ -212,6 +212,36 @@ Notice that all handlers must be async. In this sample ```OrderValidator``` is a class that validates the ```Order``` object to be modified. If it's a valid item the event returns ```true```. If the item is not valid the event writes an error on the form and returns ```false```. +## Grid column events + +Grid column provides an event to notify when a column is changed in the standard Create and Update forms. The supported event is: +- ```Func AfterChangeValue```: it's fired when the column value is changed + +This column event is configured using the ```SetAfterChangeValue``` of the ```GridColumn``` object. + +You can see here an example of the grid column definition where the method ```afterChangeCustomerID``` is fired when a new value of the ```CusotmerID``` is selected: + +```c# +c.Add(o => o.CustomerID) + .SetSelectField(true, o => o.Customer.CustomerID + " - " + o.Customer.CompanyName, f) + .SetAfterChangeValue(afterChangeCustomerID); +``` + +The fired method can do any change on the row. You can see here an example where the ```OrderDate``` field is modified only on the Create form: + +```c# +Func afterChangeCustomerID = async (order, mode) => +{ + if (mode == GridMode.Create) + { + order.OrderDate = DateTime.Now; + StateHasChanged(); + await Task.CompletedTask; + } +}; +``` + + ## Default CRUD data annotations validation GridBlazor validates by default all data annotations defined with attributes on the the model. This validation happens for Create and Update standard forms. If you use custom CRUD forms this will depend on your code. diff --git a/docs/dotnetcore_blazor/Events.md b/docs/dotnetcore_blazor/Events.md index bc2085f3..7a44d6c8 100644 --- a/docs/dotnetcore_blazor/Events.md +++ b/docs/dotnetcore_blazor/Events.md @@ -212,6 +212,36 @@ Notice that all handlers must be async. In this sample ```OrderValidator``` is a class that validates the ```Order``` object to be modified. If it's a valid item the event returns ```true```. If the item is not valid the event writes an error on the form and returns ```false```. +## Grid column events + +Grid column provides an event to notify when a column is changed in the standard Create and Update forms. The supported event is: +- ```Func AfterChangeValue```: it's fired when the column value is changed + +This column event is configured using the ```SetAfterChangeValue``` of the ```GridColumn``` object. + +You can see here an example of the grid column definition where the method ```afterChangeCustomerID``` is fired when a new value of the ```CusotmerID``` is selected: + +```c# +c.Add(o => o.CustomerID,) + .SetSelectField(true, o => o.Customer.CustomerID + " - " + o.Customer.CompanyName, f) + .SetAfterChangeValue(afterChangeCustomerID); +``` + +The fired method can do any change on the row. You can see here an example where the ```OrderDate``` field is modified only on the Create form: + +```c# +Func afterChangeCustomerID = async (order, mode) => +{ + if (mode == GridMode.Create) + { + order.OrderDate = DateTime.Now; + StateHasChanged(); + await Task.CompletedTask; + } +}; +``` + + ## Default CRUD data annotations validation GridBlazor validates by default all data annotations defined with attributes on the the model. This validation happens for Create and Update standard forms. If you use custom CRUD forms this will depend on your code.