CopyOptions
Configuration model for copying grid contents to clipboard
Signature:
export interface CopyOptions
Remarks
When setting it as an option in Grid, you only need to enter the necessary information.
Example
grid.setCopyOptions({enabled: false});
Events
Property | Type | Description |
---|---|---|
copyTextCallback | CopyTextCallback | A callback that determines the text to be copied to the clipboard |
Properties
Property | Type | Description |
---|---|---|
booleanFormat | string | Conversion format when the value is of boolean type |
copyDisplayText | boolean | Whether to copy the displayed text |
cutReadOnlyCell | boolean | Whether to initialize the value of a column that is readOnly or editable is false when cutting |
datetimeFormat | string | When the value is in date format, convert format |
enabled | boolean | Copy availability |
includeHeaderText | boolean | Whether to copy including header text |
lookupDisplay | boolean | Copy text of column where lookupDisplay is true |
multiSelectionCopyFailText | string | Error message that occurs when copying after multiple selections |
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
Remarks:
Called when a cell is copied.
If not specified or returns undefined
, value or other setting value is applied.
The format is CopyTextCallback.
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'
copyDisplayText
Whether to copy the displayed text
Type
- boolean
Remarks:
When true
, number, date, dropdown, and multicheck are copied to the displayed text.
cutReadOnlyCell
Whether to initialize the value of a column that is readOnly or editable is false
when cutting.
Type
- boolean
datetimeFormat
Conversion format when the value is in date format
Type
- string
Remarks:
Example) 'yyyy-MM-dd'
enabled
Copy availability
Type
- boolean
includeHeaderText
Whether to copy including header text
Type
- boolean
Remarks:
ex) OrderID 10233
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.
multiSelectionCopyFailText
Error message when copying after multiple selections
Type
- string
singleMode
Whether to copy only the focused cell regardless of the selection area
Type
- boolean