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

Properties

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.

copyDisplayValue

Whether to copy the calculated value

Type - boolean

Remarks:

Determines whether to copy the calculated value when summaryMode is leafAggregate and nodeAggregate is set on the column.

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

See Custom Datetime Format

Type - string

Remarks:

Example) 'yyyy-MM-dd'

enabled

Copy availability

Type - boolean

excludeHtmlTag

Whether to copy only the text excluding tags when copying text containing tags

Type - boolean

Remarks:

If set to true, when copying data from a column with an HTML renderer applied, HTML tags are removed and only the pure text is copied to the clipboard.

includeDataText

Whether to include data text for copying and pasting between grids

Type - boolean

Remarks:

When true, data for copying and pasting between grids is included in the clipboard. Applies only when copying with Ctrl + C.

includeGroupFooter

Whether to include GroupFooter values when GroupFooter is included in the selection area

Type - boolean

includeGroupHeader

Whether to include GroupHeader text when GroupHeader is included in the selection area

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