Class: SpellChecker

sync.api. SpellChecker


new SpellChecker()

After the editor has loaded (on the handler for sync.api.Workspace.EditorLifecycleEvent), you can access the spellchecker for that editor by using sync.api.Editor#getSpellChecker
Since:
  • 20.1.1

Methods


getIgnoredWords()

Return the ignored words. Returns a map of languages to lists of ignored words. Ignored words get reset on document reload.
Returns:
A map of languages to lists of ignored words.
Type
object | null

getLearnWordAction()

Get the learn word action class, if it is set.
Returns:
The learn word action class.
Type
Class.<sync.actions.AbstractAction> | null

performFullSpellCheck()

Run a full spellcheck on the document.

setLearnWordAction(learnWordActionClass)

Set the learn word action class. The context menu will create instances of this class when triggered over a spellchecking error.
Parameters:
Name Type Description
learnWordActionClass Class.<sync.actions.AbstractAction> The action which will provide the learn word functionality.