Class WatermarkPlugin

A watermark plugin to manage watermark string for roosterjs

Hierarchy

WatermarkPlugin

Implements

EditorPlugin

Index

Constructors

constructor

Properties

watermark

Methods

Constructors

constructor

new WatermarkPlugin(watermark: string, format?: WatermarkFormat): WatermarkPlugin

- Defined in roosterjs-content-model-plugins/lib/watermark/WatermarkPlugin.ts:20
Create an instance of Watermark plugin

Parameters
- watermark: string
  
  The watermark string
- Optional format: WatermarkFormat
Returns WatermarkPlugin

Properties

Protected watermark

watermark: string

Methods

dispose

dispose(): void

Implementation of EditorPlugin.dispose
- Defined in roosterjs-content-model-plugins/lib/watermark/WatermarkPlugin.ts:51
Dispose this plugin

Returns void

getName

getName(): string

Implementation of EditorPlugin.getName
- Defined in roosterjs-content-model-plugins/lib/watermark/WatermarkPlugin.ts:36
Get a friendly name of this plugin

Returns string

Protected hide

hide(editor: IEditor): void

- Defined in roosterjs-content-model-plugins/lib/watermark/WatermarkPlugin.ts:136
Parameters
- editor: IEditor
Returns void

initialize

initialize(editor: IEditor): void

Implementation of EditorPlugin.initialize
- Defined in roosterjs-content-model-plugins/lib/watermark/WatermarkPlugin.ts:44
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-content-model-plugins/lib/watermark/WatermarkPlugin.ts:59
Handle events triggered from editor

Parameters
- event: PluginEvent
  
  PluginEvent object
Returns void

Protected show

show(editor: IEditor): void

- Defined in roosterjs-content-model-plugins/lib/watermark/WatermarkPlugin.ts:115
Parameters
- editor: IEditor
Returns void

Generated using TypeDoc