Class RangeClipboardItem

Implements ReferenceableClipboard.ReferenceItem by delegating to ICellRange.ISnapshot.

Implements

ReferenceableClipboard.ReferenceItem<ICellRange.ISnapshot>

Index

Constructors

Accessors

isClipboardItem

Methods

editMode getItem getItemType getName isCut toHtml toImage toText

Constructors

constructor

new RangeClipboardItem(snapshot: ICellRange.ISnapshot): RangeClipboardItem
Parameters
- snapshot: ICellRange.ISnapshot
Returns RangeClipboardItem

Accessors

isClipboardItem

get isClipboardItem(): true
For runtime introspection.

Returns true
Implementation of ReferenceItem.isClipboardItem

Methods

editMode

editMode(): EditMode
When adding an item to the clipboard an EditMode can be associated.

Returns EditMode
Implementation of ReferenceItem.editMode

getItem

getItem(): ICellRange.ISnapshot
Access to the underling reference.

Returns ICellRange.ISnapshot
Implementation of ReferenceItem.getItem

getItemType

getItemType(): string
A key that indicates the type of item returned from getItem.

Returns string
Remarks
This should be unique key for the application.

Implementation of ReferenceItem.getItemType

getName

getName(): string
Returns string

isCut

isCut(): boolean
Indicates if the operation is a cut.

Returns boolean
Default Value
```
false
```
Implementation of ReferenceItem.isCut

toHtml

toHtml(): string | Promise<string>
Allow items to be copied as html.

Returns string | Promise<string>
Implementation of ReferenceItem.toHtml

toImage

toImage(): Blob | Promise<Blob>
Allow items to be copied as an image Blob.

Returns Blob | Promise<Blob>
Implementation of ReferenceItem.toImage

toText

toText(): string | Promise<string>
Allow items to be copied as text.

Returns string | Promise<string>
Implementation of ReferenceItem.toText