Platforms to show: All Mac Windows Linux Cross-Platform
Back to WinSpellCheckerOptionDescriptionMBS class.
WinSpellCheckerOptionDescriptionMBS.Description as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Spell Checking | MBS WinFrameworks Plugin | 21.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
The description explains the implications of making the various choices associated with the option. This should be in the language of the spell checker or localized to the user's UI language.
Raises WinSpellCheckerExceptionMBS in case of an error.
(Read only property)
WinSpellCheckerOptionDescriptionMBS.Handle as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Spell Checking | MBS WinFrameworks Plugin | 21.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
(Read only property)
WinSpellCheckerOptionDescriptionMBS.Heading as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Spell Checking | MBS WinFrameworks Plugin | 21.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
The heading can be used to group sets of options by placing the header on the first item of that group. This should be in the language of the spell checker or localized to the user's UI language.
Raises WinSpellCheckerExceptionMBS in case of an error.
(Read only property)
WinSpellCheckerOptionDescriptionMBS.Id as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Spell Checking | MBS WinFrameworks Plugin | 21.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Option identifiers all exist in the same area. Spell checker providers should use the engine identifier and the language tag (if the option is language-specific) to disambiguate potential collisions.
Specifically, the structure for naming the option identifiers should be:
For the Microsoft spell checker engine: <language tag>:<option name>. For example, "pt-BR:2009Reform."
For spell check provider engines: <engine id>:<language tag>:<option name> (the language tag may be omitted if the option is not language specific). For example, "samplespell:fr-FR:AccentedUppercase".
Spell check providers are allowed to support existing Microsoft option identifiers, but they must not create new option identifiers in the Microsoft namespace. That is, spell check providers must use the engine identifier as a prefix.
An option identifier is linked to the set of labels and the semantics associated with them. If any change needs to be made between versions to the option (adding a label to the set of labels), a new option with a new identifier must be used. The only valid change that does not require a new identifier is to change from a single label to two labels and vice-versa when the semantics for values 0 and 1 do not change.
Raises WinSpellCheckerExceptionMBS in case of an error.
(Read only property)
The items on this page are in the following plugins: MBS WinFrameworks Plugin.