Class ReferencedSheetSource

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)

Implements

Constructors

constructor

Accessors

isCopyCellsSource

Methods

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

Constructors

constructor

Accessors

isCopyCellsSource

Methods

getCopyableItems

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

  • onCancel(): void

  • Notify when the paste operation is cancelled.

    Returns void

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

  • onPaste(): boolean

  • Notify when the paste operation is complete.

    Returns boolean

rangeFrom

rangesFrom

scanCells

scanColHeaders

scanRowHeaders

sheetModel

Settings

Member Visibility

Theme

On This Page

constructorisCopyCellsSourcegetCopyableItemsisCutnameonCancelonCopyonPasterangeFromrangesFromscanCellsscanColHeadersscanRowHeaderssheetModel