Platforms to show: All Mac Windows Linux Cross-Platform

Back to WinSpellCheckerMBS class.

WinSpellCheckerMBS.Add(word as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Treats the provided word as though it were part of the original dictionary.

The word will no longer be considered misspelled, and will also be considered as a candidate for suggestions.

Raises WinSpellCheckerExceptionMBS in case of an error.

WinSpellCheckerMBS.AutoCorrect(FromWord as String, ToWord as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Causes occurrences of one word to be replaced by another.

FromWord: The incorrectly spelled word to be autocorrected.
ToWord: The correctly spelled word that should replace from.

Raises WinSpellCheckerExceptionMBS in case of an error.

WinSpellCheckerMBS.Check(text as String) as WinSpellingErrorMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Checks the spelling of the supplied text and returns a collection of spelling errors.
Example 
Var w As New WinSpellCheckerMBS("en-US")

Var Text As String = "Helo World"
Var errors() As WinSpellingErrorMBS = w.Check(Text)
Var Error As WinSpellingErrorMBS = errors(0)

MsgBox "Spelling error in """ + text.Mid(error.StartIndex+1, error.Length)+""""

text: The text to check.

Returns an array of error objects.

Raises WinSpellCheckerExceptionMBS in case of an error.

WinSpellCheckerMBS.ComprehensiveCheck(text as String) as WinSpellingErrorMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Checks the spelling of the supplied text in a more thorough manner than Check, and returns a collection of spelling errors.

Raises WinSpellCheckerExceptionMBS in case of an error.

Some examples using this method:

WinSpellCheckerMBS.Constructor(languageTag as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Creates a spell checker that supports the specified language.

languageTag: A BCP47 language tag that identifies the language for the requested spell checker.

Raises WinSpellCheckerExceptionMBS in case of an error.

WinSpellCheckerMBS.Destructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
The destructor.

WinSpellCheckerMBS.Ignore(word as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Ignores the provided word for the rest of this session.

Until this WinSpellCheckerMBS object is released, the word will no longer be considered misspelled, but it will not be considered as a candidate for suggestions.

Raises WinSpellCheckerExceptionMBS in case of an error.

WinSpellCheckerMBS.OptionDescription(optionId as String) as WinSpellCheckerOptionDescriptionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Retrieves the information (id, description, heading and labels) of a specific option.

optionId: Identifier of the option to be retrieved.
Returns WinSpellCheckerOptionDescriptionMBS interface that contains the information about optionId.

Raises WinSpellCheckerExceptionMBS in case of an error.

WinSpellCheckerMBS.OptionIds as String()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Gets all of the declared option identifiers.

Raises WinSpellCheckerExceptionMBS in case of an error.

WinSpellCheckerMBS.OptionValue(optionId as String) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Retrieves the value associated with the given option.

optionId: The option identifier.

Returns the value associated with optionId.

Raises WinSpellCheckerExceptionMBS in case of an error.

WinSpellCheckerMBS.Remove(word as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Removes a word that was previously added by Add, or set by Ignore to be ignored.

Word: The word to be removed from the list of added words, or from the list of ignored words. If the word is not present, nothing will be removed.

Raises exception if word is an empty string, or its length is greater than MAX_WORD_LENGTH (128).

Available on Windows 10 and later.

Raises WinSpellCheckerExceptionMBS in case of an error.

WinSpellCheckerMBS.Suggest(word as String) as String()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Spell Checking MBS WinFrameworks Plugin 21.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Retrieves spelling suggestions for the supplied text.
Example 
Var w As New WinSpellCheckerMBS("en-US")

Var suggestions() As String = w.Suggest("Helo")

MsgBox Join(suggestions, EndOfLine)

word: The word or phrase to get suggestions for.

Returns the list of suggestions, returned as string array.

Raises WinSpellCheckerExceptionMBS in case of an error.

Some examples using this method:

The items on this page are in the following plugins: MBS WinFrameworks Plugin.


The biggest plugin in space...