{/* Do not edit this file. It is automatically generated by API Documenter. */}


## PasteOptions

Configuration model for pasting data from the clipboard into the grid

**Signature:**

```typescript
export interface PasteOptions
```

## Remarks

When setting it as an option in [Grid](/refs/Class/GridBase), you only need to enter the necessary information.

## Example


```js
grid.setPasteOptions({enabled: false});
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [applyEditMask](/refs/Interface/PasteOptions#applyeditmask) | boolean | Whether to restrict pasting when pasting in mask is not possible |
| [applyInputChars](/refs/Interface/PasteOptions#applyinputchars) | boolean | Whether to apply inputCharacters and ignoreCharacters to editor |
| [applyMaxLength](/refs/Interface/PasteOptions#applymaxlength) | boolean | Whether to apply editor.maxLength and maxLengthExceptComma when pasting |
| [applyNumberFormat](/refs/Interface/PasteOptions#applynumberformat) | boolean | 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. |
| [booleanFormat](/refs/Interface/PasteOptions#booleanformat) | string | Format to use when converting to boolean field value in addition to the booleanFormat specified in the data field |
| [checkDomainOnly](/refs/Interface/PasteOptions#checkdomainonly) | boolean | Whether to exclude pasting values that are not in values when pasting into a column where domainOnly of DropDown Editor is `true`{/* */} |
| [checkReadOnly](/refs/Interface/PasteOptions#checkreadonly) | boolean | Whether columns with readOnly or editable `false`{/* */} are excluded from paste |
| [commitEdit](/refs/Interface/PasteOptions#commitedit) | boolean | Whether to commit existing edit status when pasting multiple rows |
| [convertLookupLabel](/refs/Interface/PasteOptions#convertlookuplabel) | boolean | When pasting a label value in DropDown Editor, whether to convert it to value and save it |
| [datetimeFormats](/refs/Interface/PasteOptions#datetimeformats) | string\[\] | Formats to use when converting to datetime field values in addition to the datetimeFormat specified in the data field |
| [enableAppend](/refs/Interface/PasteOptions#enableappend) | boolean | Whether to add rows when multiple rows to be pasted exceed the range of existing rows |
| [enabled](/refs/Interface/PasteOptions#enabled) | boolean | Paste availability |
| [eventEachRow](/refs/Interface/PasteOptions#eventeachrow) | boolean | When pasting multiple rows, whether the [onEditRowPasted](/refs/Class/GridBase#oneditrowpasted) event occurs as many rows as the number of rows |
| [fillColumnDefaults](/refs/Interface/PasteOptions#fillcolumndefaults) | boolean | Whether to fill in the values of fields not included as the default values of the column |
| [fillFieldDefaults](/refs/Interface/PasteOptions#fillfielddefaults) | boolean | Whether to fill in the values of fields that are not included with the default values of the data fields |
| [forceAppend](/refs/Interface/PasteOptions#forceappend) | boolean | When pasting a row, it is added at the end regardless of where it is pasted. |
| [forceColumnValidation](/refs/Interface/PasteOptions#forcecolumnvalidation) | boolean | Whether to perform column validation for each row when pasting multiple rows |
| [forceRowValidation](/refs/Interface/PasteOptions#forcerowvalidation) | boolean | Whether to execute row validation for each row during multi-row pasting |
| [multiSelectionPasteFailText](/refs/Interface/PasteOptions#multiselectionpastefailtext) | string | Error message that occurs when pasteOptions' selectBlockPaste is true and multiple selections are not pasted |
| [noDataEvent](/refs/Interface/PasteOptions#nodataevent) | boolean | Whether to execute refresh while pasting multiple lines of data |
| [noEditEvent](/refs/Interface/PasteOptions#noeditevent) | boolean | Whether [onEditRowChanged](/refs/Class/GridBase#oneditrowchanged){/* */}, [onCellEdited](/refs/Class/GridBase#oncelledited) occurs |
| [numberChars](/refs/Interface/PasteOptions#numberchars) | string\[\] | One or more strings that can be ignored without being judged as an error when converting to a number field value |
| [numberCharsOfCols](/refs/Interface/PasteOptions#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 |
| [numberSeparator](/refs/Interface/PasteOptions#numberseparator) | string | Character displayed as a decimal point when converting to number field value |
| [numberSeparatorOfCols](/refs/Interface/PasteOptions#numberseparatorofcols) | \{ \[key: string\]: string; \} | Character displayed as a decimal point when converting to number field value for each column |
| [selectBlockPaste](/refs/Interface/PasteOptions#selectblockpaste) | boolean | Is it possible to paste into multiple cells? |
| [selectionBase](/refs/Interface/PasteOptions#selectionbase) | boolean | Paste start position |
| [singleMode](/refs/Interface/PasteOptions#singlemode) | boolean | Whether to paste the value into only one focused cell regardless of the contents of the clipboard |
| [startEdit](/refs/Interface/PasteOptions#startedit) | boolean | Whether to start editing when pasting |
| [stopOnError](/refs/Interface/PasteOptions#stoponerror) | boolean | Whether to stop pasting when validation fails or type conversion fails |
| [throwValidationError](/refs/Interface/PasteOptions#throwvalidationerror) | boolean | Whether 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.

<hr/>

### applyInputChars

Whether to apply inputCharacters and ignoreCharacters to the editor

`Type` - boolean

<hr/>

### applyMaxLength

Whether to apply editor.maxLength and maxLengthExceptComma when pasting

`Type` - boolean

<hr/>

### 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

<hr/>

### booleanFormat

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

`Type` - string

<hr/>

### 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

<hr/>

### checkReadOnly

Whether columns with readOnly or editable `false`{/* */} are excluded from paste.

`Type` - boolean

<hr/>

### commitEdit

Whether to commit existing edit status when pasting multiple rows

`Type` - boolean

**Remarks:**

If specified as `false`, the existing edit is canceled.

<hr/>

### convertLookupLabel

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

`Type` - boolean

<hr/>

### datetimeFormats

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

`Type` - string\[\]

<hr/>

### enableAppend

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

`Type` - boolean

<hr/>

### enabled

Can you paste?

`Type` - boolean

<hr/>

### eventEachRow

When pasting multiple rows, whether the [onEditRowPasted](/refs/Class/GridBase#oneditrowpasted) event occurs for the number of rows.

`Type` - boolean

<hr/>

### fillColumnDefaults

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

`Type` - boolean

**Remarks:**

If [fillFieldDefaults](/refs/Interface/PasteOptions#fillfielddefaults) is true, the default value of the data field is applied first and then the column default value is applied. -active

<hr/>

### fillFieldDefaults

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

`Type` - boolean

<hr/>

### forceAppend

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

`Type` - boolean

<hr/>

### forceColumnValidation

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

`Type` - boolean

**Remarks:**

If [forceRowValidation](/refs/Interface/PasteOptions#forcerowvalidation) is `true`{/* */}, row validation is performed first.

<hr/>

### forceRowValidation

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

`Type` - boolean

<hr/>

### multiSelectionPasteFailText

An error message that occurs when paste is attempted after multiple selections are made when selectBlockPaste is set to true in pasteOptions.

`Type` - string

<hr/>

### noDataEvent

Whether to execute refresh while pasting multiple lines of data

`Type` - boolean

**Remarks:**

Speed is improved as it does not refresh while pasting.

<hr/>

### noEditEvent

Whether [onEditRowChanged](/refs/Class/GridBase#oneditrowchanged){/* */}, [onCellEdited](/refs/Class/GridBase#oncelledited) occurs

`Type` - boolean

**Remarks:**

[onEditRowPasted](/refs/Class/GridBase#oneditrowpasted) always occurs regardless of whether it is specified or not.

<hr/>

### 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.

<hr/>

### 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: [ , $]}`

<hr/>

### numberSeparator

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

`Type` - string

**Remarks:**

ex) `'.'`

<hr/>

### numberSeparatorOfCols

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

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

**Remarks:**

ex) `{column1: ., column2: ,}`

<hr/>

### selectBlockPaste

Is it possible to paste into multiple cells?

`Type` - boolean

**Remarks:**

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

<hr/>

### 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.

<hr/>

### singleMode

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

`Type` - boolean

<hr/>

### 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.

<hr/>

### 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.

<hr/>

### throwValidationError

Whether to raise ValidationError

`Type` - boolean

<hr/>