Defines the interface required for a class to be used as a checker engine
Declaration Syntax| C# | Visual Basic | Visual C++ |
public interface ICheckerEngine
Public Interface ICheckerEngine
public interface class ICheckerEngine
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | AddWord(String) | Adds a word to the user dictionary, if it exists. |
 | AllowAnyCase | Whether to allow words spelt with any case, eg. "africa" instead of "Africa", this is more relaxed than AllowMixedCase. |
| AllowMixedCase | Whether to allow words spelt with mixed case, eg. "MIxEd" |
| ChangeBadWord(String) | Changes the current bad word to newWord in the text. |
| ChangeBadWord(BadWord, String) | Changes badWord to newWord in the text. |
| Check(String) | Checks the text for errors. |
| CheckCompoundWords | Whether to check for compound words, setting this to true is essential for languages such as German which
allow for compound words. |
| CurrentBadWord | Gets the current bad word (last returned by NextBadWord). |
| DictFilePath | The file to be used as the main dictionary, if this is null then the RapidSpellMDict.DLL satellite assembly is used. |
| FindCapitalizedSuggestions | Whether to look for capitalized suggestions, note this will slow FindSuggestions down by about 7 times. |
| FindSuggestions()()() | Returns an ArrayList of Strings that are suitable suggestions for the current bad word (that is, the one last returned by NextBadWord()). |
| GetConsiderationRange()()() | Gets the factor for words to consider for suggestions.
|
| GetIgnoreCapitalizedWords()()() | Gets whether to ignore words that start with capital letters. |
| GetIncludeUserDictionaryInSuggestions()()() | Gets whether the user dictionary should be used in finding suggestions for misspelt words. |
| GetSuggestionsMethod()()() | Gets the suggestions method, where method is an integer identifier. |
| GetUndoableStatePoint()()() |
Gets the state of the current run, which can be stored and used with RevertToUndoableStatePoint(RapidSpellChecker..::.State) |
| IgnoreAll(String) | Marks word to be ignored in rest of the text. |
| IgnoreList | The words to ignore, note this list is changed by IgnoreAll. |
| IgnoreURLsAndEmailAddresses | Whether to ignore URLs and email addresses (requires V2Parser=true) |
| IgnoreWordsWithDigits | Whether to ignore words with numbers in them (eg. A10 or 7-11). |
| IgnoreXML | Whether to ignore XML tags in the text. |
| LanguageParser | The type of language parsing to use. |
| LookIntoHyphenatedText | Whether to 'look into' text with hyphens (-), if the word has hyphens in it and
LookIntoHyphenatedText is set true (default), the parts of the text around the hyphens will be checked individually. |
| LookUp(String) | Looks up word in the dictionary, returns true if it is in there. |
| NextBadWord()()() | Gets the next bad word in the list that was identified by Check. |
| RevertToUndoableStatePoint(RapidSpellChecker..::.State) |
Reverts the state to that it was when GetUndoableStatePoint()()() was called.
|
| SetConsiderationRange(Int32) | Sets the breadth of the suggestions search. |
| SetDictFileStream(Stream) | Dict file stream to use |
| SetIgnoreCapitalizedWords(Boolean) | Sets whether to ignore capitalized words. |
| SetIncludeUserDictionaryInSuggestions(Boolean) | Sets whether to include the user dictionary in suggestions taken from this engine. |
| SetOptionalContext(String, String) |
Provides the engine with any helpful text around the text snippet which will be passed to the Check method.
Implementation is not required.
|
| SetPosition(Int32) | Sets the pointer position for the NextBadWord iterator. |
| SetSeparateHyphenWords(Boolean) | Sets whether to separate words with hyphens in them into separate words. |
| SetSuggestionsMethod(Int32) | Sets the suggestions method, where method is an integer identifier. |
| SetUserDictionary(UserDictionary) | Sets the UserDictionary object to be used as a user dictionary source. |
| SetUserDictionary(String) | Sets the UserDictionary file path to be used as a user dictionary source. |
| SuggestSplitWords | Whether to look for connected words in suggestions. |
| TextBoundary | The AdvancedTextBoundary class to use to parse words. |
| userDictionary | The user dictionary, this should be null (C#) or nothing (VB.NET) if no user dictionary is being used. |
| V2Parser | Whether to use parser version 2 (specific to RapidSpellChecker). |
| WarnDuplicates | Whether to treat duplicate words as errors (eg. "this is is an error"). |
RemarksThis is the interface which any checker engine must have, by implementing this interface any object can be
used to parse text and identify 'bad words'.
It is not necessary to functionally implement all members, for this reason an abstract empty implementation class is provided (CheckerEngineAdapter) which can be extended and overridden for desired functionality.