Click or drag to resize
SpellChecker Class
This class can be used to initiate a spell check request using the KaxSpell dictionaries.
Inheritance Hierarchy

Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)
public class SpellChecker : IDisposable

The SpellChecker type exposes the following members.

Public methodSpellChecker
Create a new KaxSpellChecker object. You need to pass a correct path to the folder that contains the dictionary files (*.TDF)
Public methodAddToCustom
Adds a new word to the custom dictionary. It first checks if the word is already present in the current base or custom dictionaries.
Public methodCheckText
Performs the actual spellchecking. It will be automatically called by the Errors property accessor.
Public methodClose
Cleans up any resources held by the SpellChecker object. It is an alias of the Dispose method.
Public methodDispose
Clean up used resources.
Public methodGetSuggestions
Gets a list of suggestions from the dictionary for the specified word
Public propertyCustomAppendix
The suffix that gets appended to the custom dictionary file name. It is usually a user specific string that allows to distinguish dictionaries for different users. Default filenames are Language + CustomAppendix + ".txt".

Field Value

The default is -Custom
Public propertyCustomDictionarySource
Manipulate the custom dictionary source. The new value must implement ICustomDictionarySource.
Public propertyCustomDictionarySourceType
The fully qualified name of the type that will be used for the custom dictionary storage. The type name must include the assembly, culture and public key token. A new instance will be created internally unless you set CustomDictionarySource CustomDictionarySource directly.
Public propertyDictionaryLanguage
The language of the dictionary to be used for spellchecking. It usually is the same as the corresponding TDF file (without the extension).
Public propertyEditDistance
Specifies the edit distance. If you increase the value, the checking speed decreases but more suggestions are presented. It does not do anything for the phonetic spellchecking.
Public propertyErrors
The errors after the last spellcheck. The getter method will call CheckText automatically if the text has not been checked yet.
Public propertySpellCheckProvider
Specifies whether KaxSpell should use the internal spellchecking algorithm or try to use Microsoft Word. The possible values are defined in the SpellCheckProvider enum.
Public propertySpellCheckProviderTypeName
Specifies the type name for the custom spell check provider
Public propertyText
Sets the text to be spellchecked. It can be plain text or HTML.
Public propertyTextWords
This property returns the list of words that was generated when the Text property is set.
Public propertyWordIgnoreOptions
A set of rules that specify words that should be ignored during the spellcheck. Note that this property should be set before the Text property.
See Also