DkGridEdition
You can access this instance through the property named edition of the DkGridComponent.
Generics
<T>
represents the object's shape coming from the data source.
Properties
rowsInEdition
It is a read-only property that returns all the rows in edition state.
Type: DkGridDataRowEntry<T>[]
.
modifiedRows
It is a read-only property that returns all the modified rows.
Type: DkGridDataRowEntry<T>[]
.
removedRows
It is a read-only property that returns all the deleted rows.
Type: DkGridDataRowEntry<T>[]
.
editionFilterState
It is a read-only property that returns true
if the user navigates the edition filters.
Type: boolean
.
Methods
editRow()
It changes the row status to edition state.
Params:
row:
DkGridDataRowEntry<T>
.
Return: void
.
updateRow()
It saves the changes in the given row. The given row must be valid and not pristine. After updating, DkGrid sets the row status to Modified
.
Params:
row:
DkGridDataRowEntry<T>
.
Return: void
.
cancelRowEdition()
It changes the row status to Read
status. This method discards all the changes in the given row.
Params:
row:
DkGridDataRowEntry<T>
.
Return: void
.
removeRow()
It changes the row status to Deleted
status.
Params:
row:
DkGridDataRowEntry<T>
.
Return: void
.
restoreRow()
It reverts any change that the user has made.
Params:
row:
DkGridDataRowEntry<T>
.
Return: void
.
updateRowsInEdition()
It takes all valid rows which are not pristine and saves their changes.
Params: None
Return: void
.
removeRows()
It deletes the given rows that are not in the edition state.
Params:
rows:
DkGridDataRowEntry<T>[]
.
Return: void
.
cancelRowsInEdition()
It cancels the current edition state for every row, losing all the changes you have made.
Params: None.
Return: void
.
restoreRows()
It takes those modified or removed rows from the given rows and restores them to their immediate previous state.
Params:
rows:
DkGridDataRowEntry<T>[]
.
Return: void
.
setEditionFilter()
It displays the corresponding subset of rows editing.
Params:
value:
RowStatus
.
Return: void
.
cancelEditionFilter()
It makes DkGrid shows the standard view.
Params: None
Return: void
.
Events
editionRowChange
It emits the row that has been changed to edition mode.
Params: None.
Return: Observable<DkGridDataRowEntry<T>>
.
updateRowChange
It emits the modified rows.
Params: None.
Return: Observable<DkGridDataRowEntry<T> | DkGridDataRowEntry<T>[]>
.
cancelRowEditionChange
It emits the rows that have been canceled for edition.
Params: None.
Return: Observable<DkGridDataRowEntry<T> | DkGridDataRowEntry<T>[]>
.
removeRowChange
It emits the rows that have been deleted.
Params: None.
Return: Observable<DkGridDataRowEntry<T> | DkGridDataRowEntry<T>[]>
.
removeRowChange
It emits the rows that have been deleted.
Params: None.
Return: Observable<DkGridDataRowEntry<T> | DkGridDataRowEntry<T>[]>
.
restoreRowChange
It emits the rows whose changes were reverted.
Params: None.
Return: Observable<DkGridDataRowEntry<T> | DkGridDataRowEntry<T>[]>
.
editionFilterStateChange
It emits every time you navigate between the standard and the edition view.
Params: None.
Return: Observable<boolean>
.
Last updated