Class ExternalRangeClipboardItem

Implements ReferenceableClipboard.ReferenceItem by creating a ICellRange.ISnapshot from ReferenceableClipboard.NativeItems.

Remarks

IMPORTANT Before this api can be used the async parse methods needs to be called and resolved.

See

Implements

ReferenceableClipboard.ReferenceItem<ICellRange.ISnapshot>

Index

Constructors

Accessors

isClipboardItem

Methods

getItem getItemType isCut parse toHtml toImage toText

Constructors

constructor

new ExternalRangeClipboardItem(
    native: ReferenceableClipboard.NativeItems,
    markOptions?: ICellRange.CopyOptions,
    styles?: IStyleCollection,
    date1904?: boolean,
): ExternalRangeClipboardItem
Parameters
- native: ReferenceableClipboard.NativeItems
- OptionalmarkOptions: ICellRange.CopyOptions
- Optionalstyles: IStyleCollection
- Optionaldate1904: boolean
Returns ExternalRangeClipboardItem

Accessors

isClipboardItem

get isClipboardItem(): true
For runtime introspection.

Returns true
Implementation of ReferenceItem.isClipboardItem

Methods

getItem

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

Returns ICellRange.ISnapshot<ISheet>
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

isCut

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

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

parse

parse(): Promise<boolean>
Required to be called before getItem().

Returns Promise<boolean>
Remarks
This is required because the ExternalClipboard lazy loads the parsing library.

toHtml

toHtml(): string
Allow items to be copied as html.

Returns string
Implementation of ReferenceItem.toHtml

toImage

toImage(): Blob
Allow items to be copied as an image Blob.

Returns Blob
Implementation of ReferenceItem.toImage

toText

toText(): string
Allow items to be copied as text.

Returns string
Implementation of ReferenceItem.toText