Troi Text Plug-in > Script steps reference > Set Spelling Ignore List
 |
Set Spelling Ignore List |
Sets the list of words that should be ignored when checking spelling.
Syntax
Set Spelling Ignore List [ Select ; Result (error) ; Ignore Word List ]
Options
| Select entire contents | replaces the entire contents of a field with the result. If not checked the result replaces the currently selected portion of the field |
| Result (error) | an error code |
| Ignore Word List | the list of words to be ignored. Each word separated by a return |
Returned Result
Data type returned
Error code
Result
If successful the plug-in returns 0.
If unsuccessful it returns an error code starting with $$ and the error code. Returned error codes can be:
| 0 | No error | The ignore list was set. |
| $$-4221 | InvalidOSVersion | The spelling functions are not available on this platform. |
Other errors may be returned.
Originated in
Troi Text Plug-in 4.5
Compatibility
FileMaker Pro 17 to FileMaker Pro 21 (2024)
Considerations
Note that the spelling functions are available for Windows 8 and later (and all Mac OS versions).
Example
Set Spelling Ignore List [ $ErrorCode ; "WeCorp¶Dryheat¶Goupil" ] This will set the list of words to ignore (for the moment) to : “WeCorp”, “DryHeat” and “Goupil”.
You can update this by setting a different list.
You can reset this list by setting an empty Ignore Word List.
Related script steps
| Learn Spelling |
| Unlearn Spelling |
Related functions
| TrText_CheckSpelling |
| TrText_SetSpellingIgnoreList |
Related topics
Troi Text Plug-in online help (overview)