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


## CopyOptions

Configuration model for copying grid contents to clipboard

**Signature:**

```typescript
export interface CopyOptions
```

## Remarks

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

## Example


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

## Events

| Property | Type | Description |
| --- | --- | --- |
| [copyTextCallback](/refs/Interface/CopyOptions#copytextcallback) | [CopyTextCallback](/refs/realgrid#copytextcallback) | A callback that determines the text to be copied to the clipboard |

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [booleanFormat](/refs/Interface/CopyOptions#booleanformat) | string | Conversion format when the value is of boolean type |
| [copyDisplayText](/refs/Interface/CopyOptions#copydisplaytext) | boolean | Whether to copy the displayed text |
| [cutReadOnlyCell](/refs/Interface/CopyOptions#cutreadonlycell) | boolean | Whether to initialize the value of a column that is readOnly or editable is `false`{/* */} when cutting |
| [datetimeFormat](/refs/Interface/CopyOptions#datetimeformat) | string | When the value is in date format, convert format |
| [enabled](/refs/Interface/CopyOptions#enabled) | boolean | Copy availability |
| [includeHeaderText](/refs/Interface/CopyOptions#includeheadertext) | boolean | Whether to copy including header text |
| [lookupDisplay](/refs/Interface/CopyOptions#lookupdisplay) | boolean | Copy text of column where lookupDisplay is true |
| [multiSelectionCopyFailText](/refs/Interface/CopyOptions#multiselectioncopyfailtext) | string | Error message that occurs when copying after multiple selections |
| [singleMode](/refs/Interface/CopyOptions#singlemode) | boolean | Whether to copy only the focused cell regardless of the selection area |

## Events Desc

### copyTextCallback

A callback that determines the text to be copied to the clipboard.

`Type` - [CopyTextCallback](/refs/realgrid#copytextcallback)

**Remarks:**

Called when a cell is copied.

If not specified or returns `undefined`{/* */}, value or other setting value is applied.

The format is [CopyTextCallback](/refs/realgrid#copytextcallback){/* */}.

<hr/>

## Properties Desc

### booleanFormat

Conversion format when the value is of type boolean

`Type` - string

**Remarks:**

Separated with a colon (:) or semicolon (;), the left side is `false`{/* */}, and the right side is `true`{/* */}.

Example) `'N:Y'`

<hr/>

### copyDisplayText

Whether to copy the displayed text

`Type` - boolean

**Remarks:**

When `true`, number, date, dropdown, and multicheck are copied to the displayed text.

<hr/>

### cutReadOnlyCell

Whether to initialize the value of a column that is readOnly or editable is `false`{/* */} when cutting.

`Type` - boolean

<hr/>

### datetimeFormat

Conversion format when the value is in date format

`Type` - string

**Remarks:**

Example) `'yyyy-MM-dd'`

<hr/>

### enabled

Copy availability

`Type` - boolean

<hr/>

### includeHeaderText

Whether to copy including header text

`Type` - boolean

**Remarks:**

ex) OrderID 10233

<hr/>

### lookupDisplay

Copy text of column where lookupDisplay is true

`Type` - boolean

**Remarks:**

When `true`{/* */}, the column for which lookupDisplay is true copies the value of label or labelField, not the value.

<hr/>

### multiSelectionCopyFailText

Error message when copying after multiple selections

`Type` - string

<hr/>

### singleMode

Whether to copy only the focused cell regardless of the selection area

`Type` - boolean

<hr/>