Apryse WebViewer

Class: SpreadsheetEditorClipboard

Core.SpreadsheetEditor. SpreadsheetEditorClipboard

Facilitates standard clipboard operations such as copy, cut, and paste, while preserving cell data, formatting, and styling.

new SpreadsheetEditorClipboard()

Example
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, async () => {
      const spreadsheetEditorDocument = documentViewer.getDocument().getSpreadsheetEditorDocument();
      const spreadsheetEditorClipboard = spreadsheetEditorDocument.getClipboard();
    });
  });

Methods

canCopy()

Checks if the copy to clipboard operation can be performed.
Returns:
Returns true if the copy to clipboard can be performed; otherwise, false.
Type
boolean
Example
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, async () => {
      const spreadsheetEditorDocument = documentViewer.getDocument().getSpreadsheetEditorDocument();
      const spreadsheetEditorClipboard = spreadsheetEditorDocument.getClipboard();
      const canCopy = spreadsheetEditorClipboard.canCopy();
      if (canCopy) {
        // console.log('Can copy');
      }
    });
  });

canCut()

Checks if the cut operation can be performed.
Returns:
Returns true if the cut operation can be performed; otherwise, false.
Type
boolean
Example
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, async () => {
      await spreadsheetEditorManager.setEditMode(SpreadsheetEditor.SpreadsheetEditorEditMode.EDITING);
      const spreadsheetEditorDocument = documentViewer.getDocument().getSpreadsheetEditorDocument();
      const spreadsheetEditorClipboard = spreadsheetEditorDocument.getClipboard();
      const canCut = spreadsheetEditorClipboard.canCut();
      if (canCut) {
        // console.log('Can cut');
      }
    });
  });

canPaste()

Checks if the clipboard contains data that can be pasted.
Returns:
Returns true if the paste operation can be performed; otherwise, false.
Type
boolean
Example
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, async () => {
      await spreadsheetEditorManager.setEditMode(SpreadsheetEditor.SpreadsheetEditorEditMode.EDITING);
      const spreadsheetEditorClipboard = spreadsheetEditorDocument.getClipboard();
      const canPaste = spreadsheetEditorClipboard.canPaste();
      if (canPaste) {
        // console.log('Can paste');
      }
    });
  });

copy()

Copies the currently selected content to the clipboard.
Returns:
Type
void
Example
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, async () => {
      const spreadsheetEditorDocument = documentViewer.getDocument().getSpreadsheetEditorDocument();
      const spreadsheetEditorClipboard = spreadsheetEditorDocument.getClipboard();
      const canCopy = spreadsheetEditorClipboard.canCopy();
      if (canCopy) {
        spreadsheetEditorClipboard.copy();
      }
    });
  });

cut()

Cuts the currently selected content from the SheetEditor and placing it on the clipboard.
Returns:
Type
void
Example
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, async () => {
      await spreadsheetEditorManager.setEditMode(SpreadsheetEditor.SpreadsheetEditorEditMode.EDITING);
      const spreadsheetEditorDocument = documentViewer.getDocument().getSpreadsheetEditorDocument();
      const spreadsheetEditorClipboard = spreadsheetEditorDocument.getClipboard();
      const canCut = spreadsheetEditorClipboard.canCut();
      if (canCut) {
        spreadsheetEditorClipboard.cut();
      }
    });
  });

paste()

Pastes content from the clipboard.
Returns:
A promise that resolves when the paste operation is complete.
Type
Promise.<void>
Example
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, async () => {
      await spreadsheetEditorManager.setEditMode(SpreadsheetEditor.SpreadsheetEditorEditMode.EDITING);
      const spreadsheetEditorDocument = documentViewer.getDocument().getSpreadsheetEditorDocument();
      const spreadsheetEditorClipboard = spreadsheetEditorDocument.getClipboard();
      const canPaste = spreadsheetEditorClipboard.canPaste();
      if (canPaste) {
        await spreadsheetEditorClipboard.paste();
      }
    });
  });