Blazor Grid Editing
The Ignite UI for Blazor
IgbGrid component provides an easy way to perform data manipulation operations like creating, updating, and deleting records. The data manipulation phases are: Cell Editing, Row Editing, and Batch Editing (Coming Soon). The
IgbGrid gives you a powerful public API which allows you to customize the way these operations are performed.
Editable property enables you to specify the following options:
- false - the editing for the corresponding column will be disabled. This is the default value.
- true - the editing for the corresponding column will be enabled.
Keep in mind that if the column is not editable, you can still modify its value through the public API exposed by the
RowEditable property enables you to specify the following options:
- false - the row editing in the corresponding grid will be disabled. This is the default value.
- true - the row editing in the corresponding grid will be enabled.
- Cell and Batch Editing - in this scenario every singe modification of each cell is preserved separately and undo/ redo operations are available on cell level;
- Row and Batch Editing - in this scenario the modifications are preserved on row level so undo/ redo operations will not be working for each cell that is modified but for the bunch of cell from each row.
If you want to use a data type specific edit templates, you should specify the column's
DataType property. So let's now see what are the default templates for each type:
stringdata type, default template is using
numberdata type, default template is using
IgbInputtype="number", so if you try to update cell to a value which can not be parsed to a number your change is going to be discarded, and the value in the cell will be set to 0.
datedata type, default template is using
dateTimedata type, default template is using
DateTimeEditor. This editor will give you a mask directions for the input elements part of the DateTime object.
time- data type, default template is using
booleandata type, default template is using
currencydata type, default template is using
InputGroupwith prefix/suffix configuration based on application or grid locale settings.
percentdata type, default template is using
InputGroupwith suffix element that shows a preview of the edited value in percents.
- For custom templates you can see Cell Editing topic
All available column data types could be found in the official Column types topic.
Event Arguments and Sequence
The grid exposes a wide array of events that provide greater control over the editing experience. These events are fired during the Row Editing and Cell Editing lifecycle - when starting, committing or canceling the editing action.
||Fires when a cell enters edit mode (after
||If value is changed, fires just before a cell's value is committed (e.g. by pressing
||If value is changed, fires after a cell has been edited and cell's value is committed||
||Fires when a cell exits edit mode||
IgbCellwill enter edit mode.
CellEditEnter- Prevents entering cell edit. If
RowEditableis enabled, row edit will be triggered, although cell edit will remain forbidden.
Rowedit, hitting Done button or Enter won't commit the value or row transaction. Cell editing and Row editing won't be closed until Cancel button is clicked.
RowEdit- Committing cell is possible, but not the whole row. The row will stay in edit mode and the row transaction will be considered open. Hitting Done does not commit or close the row. Cancel button closes the editing process and the transaction without committing the changes.
The following sample demonstrates the editing execution sequence in action:
While a cell/row is in edit mode, a user may interact with the grid in many ways. The following table specifies how a certain interaction affects the current editing:
|Grid||Filtering||Sorting||Paging||Moving||Pinning||Hiding||GroupBy||Resizing||Escape||Enter||F2||Tab||Cell Click||Add new row/Delete/Edit|
|Keep edit mode||✔|
|Exit edit mode||✔||✔||✔||✔||✔||✔||✔||✔||✔||✔||✔||✔||✔|
As seen from the table, all interactions, except resizing a column, will end the editing and will discard the new values. Should the new value be committed, this can be done by the developer in the corresponding feature "-ing" event.
Example how to commit new values, if user tries to sort the column while a cell/row is in edit mode: