Class ReferencedSheetClipboardItem

Useful for when we are not copying from the current sheet. This abstraction exists to allow for custom sources such as a clipboard.

Remarks

There is a default implementation SheetCopySource that can be used to copy between sheets.

Hierarchy (view full)

Constructors

constructor

Accessors

isCopyCellsSource type

Methods

getCopyableItems isCellSource isCut name onCancel onCopy onPaste rangeFrom rangesFrom scanCells scanColHeaders scanRowHeaders sheetModel toHtml toText

Constructors

constructor

Accessors

isCopyCellsSource

  • get isCopyCellsSource(): true

  • For runtime introspection.

    Returns true

type

  • get type(): string

  • Returns string

Methods

getCopyableItems

isCellSource

  • isCellSource(): true

  • Returns true

isCut

  • isCut(): boolean

  • Flag to indicate if the operation is expected to be a cut.

    Returns boolean

    Default Value

    false

name

  • name(): string

  • The name of a the copy source. Useful for user interactions.

    Returns string

    Remarks

    SheetCopySource uses the sheet name to detect intersections.

onCancel

onCopy

  • onCopy(): boolean

  • This is called when the copy has read the source If copy should not be allowed (for example a read only sheet) then return false

    Returns boolean

onPaste

rangeFrom

rangesFrom

scanCells

scanColHeaders

scanRowHeaders

sheetModel

toHtml

  • toHtml(): string

  • Returns string

toText

  • toText(): string

  • Returns string

Settings

Member Visibility

Theme

On This Page

constructorisCopyCellsSourcetypegetCopyableItemsisCellSourceisCutnameonCancelonCopyonPasterangeFromrangesFromscanCellsscanColHeadersscanRowHeaderssheetModeltoHtmltoText