JVCL Help:IJvSpellChecker.Next

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Tries to find a new misspelled word.


Pascal

 functionNext(outStartIndex: Integer; outWordLength: Integer): WordBool;


Parameters

Parameters Description
out StartIndex: Integer The index in Text where the misspelled word starts.
out WordLength: Integer The length of the misspelled word.


Return Value

True if a misspelled word was found, false otherwise.


Description

Next returns true if a misspelled word was found. If a misspelled word was found, StartIndex is set to the s art of the word in Text and WordLength is set to the length of the word. Note that StartIndex is 1-based, i.e the first position in Text is 1. If Next returns false, it means that no more misspelled words can be found (i.e either when at end of Text or everything from the current point and onward is correctly spelled). Next should take Ignores as well as UserDictionary into account when scanning for misspelled words.
Use GetCurrentWord to access the word that was found by Next. Next is used in a typical spell checking application to implement "Next" functionality.


See Also

IJvSpellChecker.GetCurrentWord, IJvSpellChecker.Ignores, IJvSpellChecker.Text, IJvSpellChecker.UserDictionary


About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page