Grid InCell Editing
In Cell editing allows the user to click the cell and type the new value. When they remove focus from the input, the OnUpdate event fires, where the data-access logic can move it to the actual data source.
Sections in this article:
Basics
You can handle the OnUpdate, OnCreate and OnDelete events to perform the CUD operations, as shown in the example below. To add a new item, you must also add a command column with a Save command and a toolbar with an Add command. OnCreate will fire immediately when you click the Add button, see the Notes below.
To enable InCell editing mode, set the EditMode property of the grid to Telerik.Blazor.GridEditMode.Incell, then handle the CRUD events as shown in the example below.
Values are set in the model as soon as the user finishes editing a field, and you can receive them through the grid events (see the code comments for details)
Click a cell, edit it and click outside of the cell to see the change.
<br />
<strong>Editing is prevented for the first two items.</strong>
<TelerikGrid Data=@MyData EditMode="@GridEditMode.Incell" Pageable="true" Height="500px"
OnUpdate="@UpdateHandler" OnEdit="@EditHandler" OnDelete="@DeleteHandler" OnCreate="@CreateHandler">
<GridToolBar>
<GridCommandButton Command="Add" Icon="add">Add Employee</GridCommandButton>
</GridToolBar>
<GridColumns>
<GridColumn Field=@nameof(SampleData.ID) Title="ID" Editable="false" />
<GridColumn Field=@nameof(SampleData.Name) Title="Name" />
<GridCommandColumn>
<GridCommandButton Command="Save" Icon="save" ShowInEdit="true">Update</GridCommandButton>
<GridCommandButton Command="Delete" Icon="delete">Delete</GridCommandButton>
</GridCommandColumn>
</GridColumns>
</TelerikGrid>
@code {
void EditHandler(GridCommandEventArgs args)
{
SampleData item = (SampleData)args.Item;
// prevent opening for edit based on condition
if (item.ID < 3)
{
args.IsCancelled = true;// the general approach for cancelling an event
}
Console.WriteLine("Edit event is fired for column " + args.Field);
}
async Task UpdateHandler(GridCommandEventArgs args)
{
SampleData item = (SampleData)args.Item;
// perform actual data source operations here through your service
await MyService.Update(item);
// update the local view-model data with the service data
await GetGridData();
Console.WriteLine("Update event is fired.");
}
async Task DeleteHandler(GridCommandEventArgs args)
{
SampleData item = (SampleData)args.Item;
// perform actual data source operation here through your service
await MyService.Delete(item);
// update the local view-model data with the service data
await GetGridData();
Console.WriteLine("Delete event is fired.");
}
async Task CreateHandler(GridCommandEventArgs args)
{
SampleData item = (SampleData)args.Item;
// perform actual data source operation here through your service
await MyService.Create(item);
// update the local view-model data with the service data
await GetGridData();
Console.WriteLine("Create event is fired.");
}
// in a real case, keep the models in dedicated locations, this is just an easy to copy and see example
public class SampleData
{
public int ID { get; set; }
public string Name { get; set; }
}
public List<SampleData> MyData { get; set; }
async Task GetGridData()
{
MyData = await MyService.Read();
}
protected override async Task OnInitializedAsync()
{
await GetGridData();
}
// the following static class mimics an actual data service that handles the actual data source
// replace it with your actual service through the DI, this only mimics how the API can look like and works for this standalone page
public static class MyService
{
private static List<SampleData> _data { get; set; } = new List<SampleData>();
public static async Task Create(SampleData itemToInsert)
{
itemToInsert.ID = _data.Count + 1;
_data.Insert(0, itemToInsert);
}
public static async Task<List<SampleData>> Read()
{
if (_data.Count < 1)
{
for (int i = 1; i < 50; i++)
{
_data.Add(new SampleData()
{
ID = i,
Name = "Name " + i.ToString()
});
}
}
return await Task.FromResult(_data);
}
public static async Task Update(SampleData itemToUpdate)
{
var index = _data.FindIndex(i => i.ID == itemToUpdate.ID);
if (index != -1)
{
_data[index] = itemToUpdate;
}
}
public static async Task Delete(SampleData itemToDelete)
{
_data.Remove(itemToDelete);
}
}
}
The result from the code snippet above, after the user clicks in the Name column of the fifth row
Notes
-
The
OnCreateevent will fire as soon as you click theAddbutton so you can add the new row to the gridData- this will let it show up in the grid, and then enter edit mode for the first editable column (to fireOnEditand let the user alter the column). This means you should have default values that satisfy any initial validation and requirements your models may have.- This means that there is no actual inserted item, an item in InCell editing is always in Edit mode, never in Insert mode. Thus, you cannot use the
InsertedItemfield of the grid State. If you want to insert items programmatically in the grid, alter theDatacollection, and use theOriginalEditItemfeature of the state (see the Initiate Editing or Inserting of an Item example - it can put the InLine and PopUp edit modes in Insert mode, but this cannot work for InCell editing).
- This means that there is no actual inserted item, an item in InCell editing is always in Edit mode, never in Insert mode. Thus, you cannot use the
-
When the InCell Edit Mode is enabled and you want to enable item selection a
<GridCheckboxColumn />must be added to the<Columns>collection. More information on that can be read in the Selection article.- To see how to select the row that is being edited in InCell edit mode without using a
<GridCheckboxColumn />check out the Row Selection in Edit with InCell EditMode Knowledge Base article.
- To see how to select the row that is being edited in InCell edit mode without using a
It is up to the data access logic to save the data once it is changed in the data collection. The example above showcases when that happens and adds some code to provide a visual indication of the change. In a real application, the code for handling data updates may be entirely different.
-
The
OnCancelevent and theCancelcommand button are not supported in InCell editing mode. Clicking outside the currently edited cell will trigger theOnUpdateevent and thus, clicking on theCancelcommand button will not fire theOnCancelevent.- If there is a cell that is being edited at the moment, clicking on another cell will first close the current cell and fire
OnUpdate. To start editing the new cell in such a case you will need a second click.
- If there is a cell that is being edited at the moment, clicking on another cell will first close the current cell and fire
-
When using an editor template, the grid cannot always know what the custom editor needs to do, and when it needs to close the cell and update the data, because this is up to the editor. Thus, you can use the grid state to close the cell and invoke the desired operations on the data according to your business logic. For example, a suitable event the Telerik input components provide is
OnChange.- When keyboard navigation is enabled in the grid (
Navigable=true), the grid will captureEnterkeypresses when the cell is focused, and will close the cell with the corresponding update. You can either use that (e.g., a simple input will let the keypress event propagate to the grid cell), or you can prevent the event propagation and use only your business logic.
The example below shows how you can use both a navigable grid and events on the custom editor templates to close the cells when Enter is pressed or when they lose focus, much like an Excel spreadsheet behaves.
.razor
@* The Telerik-specific OnChange event is used to achieve this in this example. You can implement a similar event in your components/editors, or use a completely different event and logic to instruct the grid to update a cell. In this example, the two-way binding provides the editor value to the model immediately, so it becomes avaialable in the OnChange handler. In your case you might need to handle this differently, depending on the logic you need. *@ <TelerikGrid @ref="@Grid" Data=@MyData EditMode="@GridEditMode.Incell" Pageable="true" Height="500px" OnUpdate="@UpdateHandler" OnCreate="@CreateHandler"> <GridColumns> <GridColumn Field=@nameof(SampleData.ID) Editable="false" Title="ID" /> <GridColumn Field=@nameof(SampleData.Name) Title="Name"> <EditorTemplate> @{ currentItem = context as SampleData; <TelerikTextBox @bind-Value=@currentItem.Name OnChange="@CloseEditor" Width="100%" /> } </EditorTemplate> </GridColumn> <GridColumn Field=@nameof(SampleData.Ranking) Title="Ranking" Width="120px"> <EditorTemplate> @{ currentItem = context as SampleData; <TelerikNumericTextBox @bind-Value=@currentItem.Ranking OnChange="@CloseEditor" Width="100%" Max="10" Min="0" Step="1"> </TelerikNumericTextBox> } </EditorTemplate> </GridColumn> <GridColumn Field=@nameof(SampleData.Role) Title="Position" Width="200px"> <EditorTemplate> @{ currentItem = context as SampleData; <TelerikDropDownList Data="@Roles" @bind-Value="@currentItem.Role" OnChange="@CloseEditor" Width="120px" PopupHeight="auto"> </TelerikDropDownList> } </EditorTemplate> </GridColumn> <GridCommandColumn> <GridCommandButton Command="Save" Icon="save" ShowInEdit="true">Save</GridCommandButton> </GridCommandColumn> </GridColumns> <GridToolBar> <GridCommandButton Command="Add" Icon="add">Add Employee</GridCommandButton> </GridToolBar> </TelerikGrid> @code { // handling the custom editor template for InCell editing public TelerikGrid<SampleData> Grid { get; set; } public SampleData currentItem { get; set; } async Task CloseEditor() { var state = Grid?.GetState(); if (currentItem.ID == 0 && state.InsertedItem != null) { // insert operation - the item is new await CreateHandler(new GridCommandEventArgs() { Item = state.InsertedItem }); } else if (currentItem.ID > 0 && state.EditItem != null) { // edit operation on an existing item await UpdateHandler(new GridCommandEventArgs() { Item = state.EditItem, Field = state.EditField }); } state.InsertedItem = state.OriginalEditItem = state.EditItem = default; await Task.Delay(20); // let the grid re-render and close the cell if keyboard navigation is enabled await Grid?.SetState(state); } //Create and Update operations async Task UpdateHandler(GridCommandEventArgs args) { SampleData item = (SampleData)args.Item; var index = MyData.FindIndex(i => i.ID == item.ID); if (index != -1) { // with keyboard navigation and Enter key press in the component // both the grid, and the OnChange handler will raise the update event // you may want to add an equality comparison for the item to only call the database once // when the item has changed, not both times if (!MyData[index].Equals(item)) { MyData[index] = item; Console.WriteLine("update"); //perform actual data source operations here } } } async Task CreateHandler(GridCommandEventArgs args) { SampleData item = (SampleData)args.Item; item.ID = MyData.Count + 1; MyData.Insert(0, item); Console.WriteLine("create"); // perform actual data source operation here through your service } // data sources protected override void OnInitialized() { MyData = new List<SampleData>(); for (int i = 1; i < 50; i++) { MyData.Add(new SampleData() { ID = i, Name = "name " + i, Ranking = i % 10 }); } } public class SampleData { public int ID { get; set; } public string Name { get; set; } public string Role { get; set; } public int Ranking { get; set; } public override bool Equals(object obj) { if (obj != null && obj is SampleData) { SampleData curr = obj as SampleData; return (ID == curr.ID) && (Name == curr.Name) && (Role == curr.Role) && (Ranking == curr.Ranking); } return false; } } List<SampleData> MyData { get; set; } static List<string> Roles = new List<string> { "Manager", "Employee", "Contractor" }; } - When keyboard navigation is enabled in the grid (