EditOptions

Configuration model for data editing in grid

Signature:

export interface EditOptions

Remarks

When setting it as an option in Grid, you only need to enter the necessary information.

Example

grid.setEditOptions({editable: false});

Properties

Properties Desc

appendable

Can rows be added?

Type - boolean

Remarks:

Can be added using the arrow keys in the last row of the grid

appendWhenExitLast

Whether to add rows when leaving the last cell with Tab or Enter

Type - boolean

Remarks:

commitWhenExitLast must be true.

appendWhenInsertKey

Whether to add a row at the end with the Insert key

Type - boolean

buttonClickWhenSpace

Type - boolean

cancelWhenLastUndo

Can you cancel editing?

Type - boolean

checkable

Whether the Checked state of a row can be changed

Type - boolean

Remarks:

When true, it can be changed by clicking the CheckBar Cell.

checkCellDiff

Whether to check the status change when the actual value is changed upon completion of cell editing

Type - boolean

Remarks:

If true, when requesting completion of cell editing, there must be at least one actual changed value to be completed. Otherwise it is ignored. If false, the row will be in a changed state if there was a user editing action, regardless of whether the actual value was changed.

checkDiff

Whether to check the status change when the actual cell is changed upon completion of row editing

Type - boolean

Remarks:

When true, when a row edit completion request is completed, there must be at least one cell that has actually been changed. Otherwise it is ignored. When false, regardless of whether the actual value has changed, if there has been a user editing action, the row will be in a changed state.

columnEditableFirst

Change application order of column.editable and editOptions.editable

Type - boolean

Remarks:

If true, editOptions.editable is ignored if column.editable is set.

commitByCell

Whether to commit after cell-level modification

Type - boolean

commitEditingMessage

Message displayed when deleting the row being edited

Type - string

Remarks:

Displayed when EditOptions.deletableWhenEdit is false.

commitLevel

The highest ValidationLvel at which row editing can be completed.

Type - ValidationLevel

commitWhenExitLast

Whether to commit the row when leaving the cell with the Tab or Enter key

Type - boolean

commitWhenLeave

Whether to commit the grid when focus leaves the grid

Type - boolean

commitWhenNoEdit

Whether to commit even if the cell is not edited

Type - boolean

confirmWhenDelete

Whether to call a dialog asking whether to delete or not

Type - boolean

Remarks:

If true, when deleting a user or executing deleteSelection(), a dialog box asking whether to delete is called first. When called with GridView.deleteSelection(true), it is deleted immediately without displaying a dialog box.

crossWhenExitLast

Whether to move to the next row when leaving the last cell with Tab or Enter key

Type - boolean

currentChangingFirst

Execution order of commitEdit and GridBase.onCurrentChanging

Type - boolean

Remarks:

If true, the onCurrentChanging event is executed before the grid's commitEdit.

deletable

Can rows be deleted?

Type - boolean

Remarks:

When true, the user can delete the currently selected row by pressing the Ctrl+Del keys or calling deleteSelection(). If you call it with deleteSelection(true), it can be deleted regardless of the option.

deletableWhenEdit

When editing a cell, whether it is possible to delete the selected row after canceling the edit.

Type - boolean

deleteRowsMessage

Message to display in delete dialog box

Type - string

displayEmptyEditRow

Whether to always add an empty row at the end of grid rows

Type - boolean

Remarks:

When data is entered into the blank row and row commit() occurs, the blank row is added again.

editable

Whether data in the grid can be modified

Type - boolean

Remarks:

The readOnly value specified in each column must also be false to be modified.

editWhenClickFocused

Whether to display the editor when clicking on a selected cell

Type - boolean

editWhenFocused

Whether to display the editor when focusing on a cell

Type - boolean

enterToEdit

When the focused cell is not in the editing state, pressing the Enter key changes it to the editing state.

Type - boolean

Remarks:

If enterToNextRow is true, it moves to the next row without changing to the editing state.

enterToNextCell

When you press Enter, you move to the next cell.

Type - boolean

enterToNextRow

Whether to complete editing and move to the next row when you press Enter while editing a cell.

Type - boolean

enterToTab

Whether to complete editing and move to the next cell when you press Enter while editing a cell.

Type - boolean

Remarks:

Move to next row when enterToNextRow == true

erasable

Whether cells included in the selection can be deleted

Type - boolean

exceptDataClickWhenButton

Whether GridBase.onCellClicked occurs when a cellButton or renderer item is clicked.

Type - boolean

Remarks:

If true, the onCellClicked event does not occur.

exitGridWhenTab

Whether to leave the grid when pressing the tab key

Type - ExitGridWhenTab

firstCellWhenInsert

Type - boolean

focusMoveStep

When you input the left or right arrow, the focus moves by cell or group.

Type - FocusMoveStep

Remarks:

If group, the focus moves to the highest group unit.

forceAppend

Whether to always commit in Appending state even if there are no changes

Type - boolean

forceInsert

Whether to always commit in the inserting state even if there are no changes

Type - boolean

hintOnError

Whether to display an error hint tooltip when the mouse is placed on a cell with an error during editing

Type - boolean

insertable

Whether rows can be inserted

Type - boolean

Remarks:

When true, rows can be inserted by pressing the Insert key.

invalidFormatMessage

Error message to display when it is not in the format specified by mask

Type - string

maxLengthToNextCell

Whether to move to the next cell when the specified number of digits are entered.

Type - boolean

Remarks:

When the number of digits specified in column.editor.maxLength is entered, it moves to the next cell. If editFormat is present, maxLength is checked based on the displayed characters. (numberEditor, dateEditor) In the case of multiLine, control characters such as \n are also included in the number of characters. if editOptions.skipReadOnly is true Cells that are readOnly are skipped.

movable

Is it possible to move a row?

Type - boolean

Remarks:

If it is in a sorted state, it cannot be moved. In the case of a tree, movement is possible only within the same node.

movableWhenFocusedOnly

포커스를 가진 셀 에서만 행 이동 여부

Type - boolean

Remarks:

movable 이 true 여야 한다.

readOnly

Whether to prevent modification of values in data cells at the grid level

Type - boolean

Remarks:

The readOnly value specified in each column must also be false to be modified.

revertable

Is it possible to cancel deletion?

Type - boolean

Remarks:

If dataProvider.softDeleting == true, rows in the deleted state can be returned to their original state by pressing the ctrl+shift+del keys.

scrollOnEditing

Processing when scrolling while editing

Type - ScrollOnEditing

showCommitError

Whether to show when a commit error occurs

Type - boolean

showInvalidFormatMessage

Whether to show an error message when it is not in the format specified by mask.

Type - boolean

showOnlyValidationMessage

Whether to show only the set Validation Error message

Type - boolean

Remarks:

If true, only the message of validation is shown. If false, level and message are shown simultaneously. . To change the message on a per-cell basis, see GridBase.onValidationFail

skipReadOnly

Whether to skip readOnly cells when moving between columns.

Type - boolean

skipReadOnlyCell

Whether to skip readOnly cells when moving between rows in one column.

Type - boolean

strictDiff

Whether to check whether the actual value has changed when editing a cell by judging it strictly (data type must also be the same)

Type - boolean

Remarks:

If true, when requesting completion of cell editing, there must be at least one actual changed value to be completed. Otherwise it is ignored. If false, the row will be in a changed state if there was a user editing action, regardless of whether the actual value was changed.

updatable

Whether data in the grid can be modified

Type - boolean

Remarks:

If true, data in the grid can be modified. If false, existing data cannot be modified, and only newly added rows before commit() can be modified.

useArrowKeys

Is it possible to move cells using the direction keys?

Type - boolean

useTabKey

Whether cells can be moved using the Tab key

Type - boolean

validateOnEdited

Whether to execute column validation when cell editing is completed

Type - boolean

validateOnExit

Warning: This API is now obsolete.

Whether to perform column validation when leaving a cell

Type - boolean

verticalMoveStep

How to operate when moving a column cell in a column group up or down

Type - VerticalMoveStep

Remarks:

It is 'row' or 'cell'.