RealGrid2 API
Interface
PasteOptions

PasteOptions

Configuration model for pasting data from the clipboard into the grid

Signature:

export interface PasteOptions

Remarks

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

Example

grid.setPasteOptions({enabled: false});

Properties

PropertyTypeDescription
applyEditMaskbooleanWhether to restrict pasting when pasting in mask is not possible
applyInputCharsbooleanWhether to apply inputCharacters and ignoreCharacters to editor
applyMaxLengthbooleanWhether to apply editor.maxLength and maxLengthExceptComma when pasting
applyNumberFormatbooleanWhen pasting, if there is an editFormat, it is pasted in editFormat format. If there is no editFormat, it is pasted in styles.numberFormat format.
booleanFormatstringFormat to use when converting to boolean field value in addition to the booleanFormat specified in the data field
checkDomainOnlybooleanWhether to exclude pasting values that are not in values when pasting into a column where domainOnly of DropDown Editor is true
checkReadOnlybooleanWhether columns with readOnly or editable false are excluded from paste
commitEditbooleanWhether to commit existing edit status when pasting multiple rows
convertLookupLabelbooleanWhen pasting a label value in DropDown Editor, whether to convert it to value and save it
datetimeFormatsstring[]Formats to use when converting to datetime field values in addition to the datetimeFormat specified in the data field
enableAppendbooleanWhether to add rows when multiple rows to be pasted exceed the range of existing rows
enabledbooleanPaste availability
eventEachRowbooleanWhen pasting multiple rows, whether the onEditRowPasted event occurs as many rows as the number of rows
fillColumnDefaultsbooleanWhether to fill in the values of fields not included as the default values of the column
fillFieldDefaultsbooleanWhether to fill in the values of fields that are not included with the default values of the data fields
forceAppendbooleanWhen pasting a row, it is added at the end regardless of where it is pasted.
forceColumnValidationbooleanWhether to perform column validation for each row when pasting multiple rows
forceRowValidationbooleanWhether to execute row validation for each row during multi-row pasting
noDataEventbooleanWhether to execute refresh while pasting multiple lines of data
noEditEventbooleanWhether onEditRowChanged, onCellEdited occurs
numberCharsstring[]One or more strings that can be ignored without being judged as an error when converting to a number field value
numberCharsOfCols{ [key: string]: string[]; }One or more strings that can be ignored without being judged as an error when converting to number field values for each column
numberSeparatorstringCharacter displayed as a decimal point when converting to number field value
numberSeparatorOfCols{ [key: string]: string; }Character displayed as a decimal point when converting to number field value for each column
selectBlockPastebooleanIs it possible to paste into multiple cells?
selectionBasebooleanPaste start position
singleModebooleanWhether to paste the value into only one focused cell regardless of the contents of the clipboard
startEditbooleanWhether to start editing when pasting
stopOnErrorbooleanWhether to stop pasting when validation fails or type conversion fails
throwValidationErrorbooleanWhether to raise ValidationError

Properties Desc

applyEditMask

Whether to restrict pasting when pasting in mask is not possible

Type - boolean

Remarks:

If it is longer than the number of digits entered in the mask, it is pasted excluding the digits entered in the mask.


applyInputChars

Whether to apply inputCharacters and ignoreCharacters to the editor

Type - boolean


applyMaxLength

Whether to apply editor.maxLength and maxLengthExceptComma when pasting

Type - boolean


applyNumberFormat

When pasting, if there is an editFormat, it is pasted in editFormat format. If there is no editFormat, it is pasted in styles.numberFormat format.

Type - boolean


booleanFormat

Format to use when converting to a boolean field value other than the booleanFormat specified in the data field.

Type - string


checkDomainOnly

Whether to exclude pasting values that are not in values when pasting into a column where domainOnly of DropDown Editor is true

Type - boolean


checkReadOnly

Whether columns with readOnly or editable false are excluded from paste.

Type - boolean


commitEdit

Whether to commit existing edit status when pasting multiple rows

Type - boolean

Remarks:

If specified as false, the existing edit is canceled.


convertLookupLabel

When pasting a label value in DropDown Editor, whether to convert it to value and save it.

Type - boolean


datetimeFormats

Formats to use when converting to datetime field values in addition to the datetimeFormat specified in the data field.

Type - string[]


enableAppend

Whether to add rows when multiple rows to paste exceed the range of existing rows

Type - boolean


enabled

Can you paste?

Type - boolean


eventEachRow

When pasting multiple rows, whether the onEditRowPasted event occurs for the number of rows.

Type - boolean


fillColumnDefaults

Whether to fill in the values of fields not included as the default values of the column.

Type - boolean

Remarks:

If fillFieldDefaults is true, the default value of the data field is applied first and then the column default value is applied. -active


fillFieldDefaults

Whether to fill in the values of fields that are not included with the default values of the data fields.

Type - boolean


forceAppend

When pasting a row, it is added at the end regardless of where it is pasted.

Type - boolean


forceColumnValidation

Whether to execute column validation for each row when pasting multiple rows

Type - boolean

Remarks:

If forceRowValidation is true, row validation is performed first.


forceRowValidation

Whether to execute row validation for each row during multi-row pasting

Type - boolean


noDataEvent

Whether to execute refresh while pasting multiple lines of data

Type - boolean

Remarks:

Speed is improved as it does not refresh while pasting.


noEditEvent

Whether onEditRowChanged, onCellEdited occurs

Type - boolean

Remarks:

onEditRowPasted always occurs regardless of whether it is specified or not.


numberChars

One or more strings that can be ignored without being judged as an error when converting to a number field value.

Type - string[]

Remarks:

Replaces all specified strings with empty strings and then converts them to numbers.


numberCharsOfCols

One or more strings that are not judged as errors and can be ignored when converting to number field values for each column.

Type - { [key: string]: string[]; }

Remarks:

ex) {column1: [,, kr], column2: [ , $]}


numberSeparator

Character displayed as a decimal point when converted to number field value

Type - string

Remarks:

ex) '.'


numberSeparatorOfCols

Character displayed as a decimal point when converting to number field value for each column

Type - { [key: string]: string; }

Remarks:

ex) {column1: ., column2: ,}


selectBlockPaste

Is it possible to paste into multiple cells?

Type - boolean

Remarks:

You can copy one cell and then paste it into multiple cells.


selectionBase

Paste start position

Type - boolean

Remarks:

When true, paste from the first cell of the selection area containing the focus cell. When false, paste from the focus cell.


singleMode

Whether to paste the value into only one focused cell regardless of the contents of the clipboard

Type - boolean


startEdit

Whether to start editing when pasting

Type - boolean

Remarks:

If the value to be pasted is not multiple rows and the row to be pasted is not yet being edited, start editing. If false, the data row connected to this row is updated.


stopOnError

Whether to stop pasting when validation fails or type conversion fails.

Type - boolean

Remarks:

If false, the process continues, but rows with errors are skipped and pasted.


throwValidationError

Whether to raise ValidationError

Type - boolean