Class CustomReplace

Wrapper for CustomReplaceContentEditFeature that provides an API for updating the content edit feature

Hierarchy

CustomReplace

Implements

EditorPlugin

Index

Constructors

constructor

Methods

Constructors

constructor

new CustomReplace(replacements?: CustomReplacement[]): CustomReplace

- Defined in roosterjs-editor-plugins/lib/plugins/CustomReplace/CustomReplace.ts:36
Create instance of CustomReplace plugin

Parameters
- replacements: CustomReplacement[] = ...
  
  Replacement rules. If not passed, a default replacement rule set will be applied
Returns CustomReplace

Methods

dispose

dispose(): void

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

Returns void

getName

getName(): string

Implementation of EditorPlugin.getName
- Defined in roosterjs-editor-plugins/lib/plugins/CustomReplace/CustomReplace.ts:59
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/CustomReplace/CustomReplace.ts:67
Initialize this plugin

Parameters
- editor: IEditor
  
  The editor instance
Returns void

onPluginEvent

onPluginEvent(event: PluginEvent): void

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

Parameters
- event: PluginEvent
  
  PluginEvent object
Returns void

updateReplacements

updateReplacements(newReplacements: CustomReplacement[]): void

- Defined in roosterjs-editor-plugins/lib/plugins/CustomReplace/CustomReplace.ts:50
Set the replacements that this plugin is looking for.

Parameters
- newReplacements: CustomReplacement[]
  
  new set of replacements for this plugin
Returns void

Generated using TypeDoc