Class Paste

Paste plugin, handles BeforePaste event and reformat some special content, including:

Content copied from Word
Content copied from Excel
Content copied from Word Online or OneNote Online

Hierarchy

Paste

Implements

EditorPlugin

Index

Constructors

constructor

Methods

Constructors

constructor

new Paste(unknownTagReplacement?: string, convertSingleImageBody?: boolean): Paste

- Defined in roosterjs-editor-plugins/lib/plugins/Paste/Paste.ts:29
Construct a new instance of Paste class

Parameters
- unknownTagReplacement: string = 'SPAN'
  
  Replace solution of unknown tags, default behavior is to replace with SPAN
- convertSingleImageBody: boolean = false
  
  When enabled, if clipboard HTML contains a single image, we reuse the image without modifying the src attribute. When disabled, pasted image src attribute will use the dataUri from clipboard data -- By Default disabled.
Returns Paste

Methods

dispose

dispose(): void

Implementation of EditorPlugin.dispose
- Defined in roosterjs-editor-plugins/lib/plugins/Paste/Paste.ts:60
Dispose this plugin

Returns void

getName

getName(): string

Implementation of EditorPlugin.getName
- Defined in roosterjs-editor-plugins/lib/plugins/Paste/Paste.ts:45
Get a friendly name of this plugin

Returns string

initialize

initialize(editor: IEditor): void

Implementation of EditorPlugin.initialize
- Defined in roosterjs-editor-plugins/lib/plugins/Paste/Paste.ts:53
Initialize this plugin. This should only be called from Editor

Parameters
- editor: IEditor
  
  Editor instance
Returns void

onPluginEvent

onPluginEvent(event: PluginEvent): void

Implementation of EditorPlugin.onPluginEvent
- Defined in roosterjs-editor-plugins/lib/plugins/Paste/Paste.ts:68
Handle events triggered from editor

Parameters
- event: PluginEvent
  
  PluginEvent object
Returns void

Generated using TypeDoc