Class Watermark

A watermark plugin to manage watermark string for roosterjs

Hierarchy

Watermark

Implements

EditorPlugin

Index

Constructors

constructor

Methods

Constructors

constructor

new Watermark(watermark: string, format?: DefaultFormat, customClass?: string): Watermark

- Defined in roosterjs-editor-plugins/lib/plugins/Watermark/Watermark.ts:20
Create an instance of Watermark plugin

Parameters
- watermark: string
  
  The watermark string
- Optional format: DefaultFormat
- Optional customClass: string
Returns Watermark

Methods

dispose

dispose(): void

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

Returns void

getName

getName(): string

Implementation of EditorPlugin.getName
- Defined in roosterjs-editor-plugins/lib/plugins/Watermark/Watermark.ts:61
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/Watermark/Watermark.ts:69
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/Watermark/Watermark.ts:90
Handle events triggered from editor

Parameters
- event: PluginEvent
  
  PluginEvent object
Returns void

updateWatermark

updateWatermark(watermark: string): void

- Defined in roosterjs-editor-plugins/lib/plugins/Watermark/Watermark.ts:40
Updates the watermark text.

Parameters
- watermark: string
  
  The new watermark text.
Returns void

Generated using TypeDoc