A newer version of this page is available.
Switch to the current version.
SpellChecker Members
The component that allows you to add Microsoft Office style spell checking capabilities into your application.Constructors
| Name | Description |
|---|---|
| SpellChecker() | Initializes a new instance of the SpellChecker class with default settings. |
| SpellChecker(IContainer) | Initializes a new instance of the SpellChecker class with the specified container. |
Properties
| Name | Description |
|---|---|
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| ChangeAllList | Provides access to the list of words and their counterparts that replace them on every occurrence. Inherited from SpellCheckerBase. |
| CheckAsYouTypeOptions | Provides access to the options used to visually indicate misspelled words and customize the context menu, invoked by right-clicking the word. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| Culture | Gets or sets the culture-specific settings of the spell checker. Inherited from SpellCheckerBase. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| Dictionaries | Provides access to the spell checker dictionaries collection. Inherited from SpellCheckerBase. |
| DictionaryHelper | Provides access to the object which facilitates dictionary operations. Inherited from SpellCheckerBase. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| FormsManager | Provides access to the object that manages the spelling forms for user interaction. |
| IgnoreList | Provides access to a list of ignored words. Inherited from SpellCheckerBase. |
| LevenshteinDistance | Gets or sets the parameter used to measure the proximity of words to be included in a suggestion collection. Inherited from SpellCheckerBase. |
| LoadOnDemand | Gets or sets whether the dictionary is not loaded until the spell checker language has matched the dictionary language. Inherited from SpellCheckerBase. |
| LookAndFeel | Provides access to the settings which control the SpellChecker look and feel appearance. |
| OptionsSpelling | Provides access to the spelling options set for the spell checker instance. |
| ParentContainer | Gets or sets the control, representing the parent container for the XtraSpellChecker instance. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| SpellCheckMode | Gets or sets the XtraSpellChecker's operation mode. |
| SpellingFormType | Gets or sets the type of form that is shown when a possible misspelled word is found. Inherited from SpellCheckerBase. |
| SuggestionSearchTimeOut | Gets or sets the timeout for calculating suggestions. Inherited from SpellCheckerBase. |
| UseSharedDictionaries | Specifies whether the spell checker should use the shared dictionaries collection in a word search. For WinForms Spell Checker only. Inherited from SpellCheckerBase. |
Methods
| Name | Description |
|---|---|
| About() static | Invokes the About dialog box. |
| CalcError(Point) | Performs a spell check of the word, which occupies the rectangular area to which the specified point belongs. |
| CanCheck(Control) | Checks whether the control is registered to be used with the XtraSpellChecker. |
| Check(ISpellCheckTextControlController) | Checks the spelling of the text available through the controller interface. |
| Check(ISpellCheckTextController) | Checks the spelling of the text available through the controller interface. Inherited from SpellCheckerBase. |
| Check(String) | Checks the spelling of words in a text string and invokes the spelling dialog if an error is found. Inherited from SpellCheckerBase. |
| Check(String, Position, Position) | Checks the spelling of words in a text string. Inherited from SpellCheckerBase. |
| Check(Control) | Checks the specified control for spelling mistakes. |
| CheckContainer() | Checks the controls in the container of current control for spelling mistakes. |
| CheckContainer(Control) | Checks the controls within the container for spelling mistakes. |
| CheckText(String) | Checks the specified text to get a list of erroneous words and suggested corrections. Inherited from SpellCheckerBase. |
| CheckText(String, Boolean) | Obsolete. Checks the specified text to get a list of erroneous words and suggested corrections. Inherited from SpellCheckerBase. |
| CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| GetCanCheckText(Control) | Returns a value that determines whether the control can be processed by a spell checker. |
| GetCommandsByError(SpellCheckErrorBase) | Creates a list of commands, available to the end-user, which depend on the type of misspelling and current spellchecker operation mode. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetIgnoreList(Control) | Returns the list of words ignored during spell check. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetShowSpellCheckMenu(Control) | Returns a value that determines whether the command that invokes the spell checker should be added to the control's drop-down menu. |
| GetSpellCheckerOptions(Control) | Gets the options of spelling check specified for the control. |
| GetSuggestions(String) | Gets suggested words to replace a specified word. Inherited from SpellCheckerBase. |
| GetSuggestions(String, CultureInfo) | Gets suggested words to replace a specified word. Inherited from SpellCheckerBase. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| IsMisspelledWord(String, CultureInfo) | Checks whether the specified word is, according to the dictionary, misspelled for the specified culture. Inherited from SpellCheckerBase. |
| IsMisspelledWord(String, CultureInfo, Position, Position) | Checks whether the specified word is misspelled according to the dictionary for the specified culture, starting from and ending at the specified positions. Inherited from SpellCheckerBase. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RestoreFromRegistry(String) | Reconstitute the spell checker object from the data in the registry. Inherited from SpellCheckerBase. |
| RestoreFromStream(Stream) | Loads data from the specified stream and creates the XtraSpellChecker object from it. Inherited from SpellCheckerBase. |
| RestoreFromXML(String) | Loads data from the specified XML file and creates the XtraSpellChecker object from it. Inherited from SpellCheckerBase. |
| SaveToRegistry(String) | Serializes the spell checker object and saves the data into the registry. Inherited from SpellCheckerBase. |
| SaveToStream(Stream) | Serializes XtraSpellChecker objects and writes the data to the specified stream. Inherited from SpellCheckerBase. |
| SaveToXML(String) | Serializes XtraSpellChecker objects and writes the data to the specified XML file. Inherited from SpellCheckerBase. |
| SetCanCheckText(Control, Boolean) | Returns a value that specifies whether the control can be processed by a spell checker. |
| SetShowSpellCheckMenu(Control, Boolean) | Specifies a value that determines whether the command that invokes the spell checker should be added to the control's drop-down menu. |
| SetSpellCheckerOptions(Control, OptionsSpelling) | Sets the options of spelling check specified for the control. |
| ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
Events
| Name | Description |
|---|---|
| AfterCheck | Occurs when text checking is finished. Inherited from SpellCheckerBase. |
| AfterCheckWord | Occurs after a word is checked. Inherited from SpellCheckerBase. |
| AfterLoadDictionaries | Occurs when the dictionaries have been loaded. Inherited from SpellCheckerBase. |
| BeforeCheck | Occurs before the spell checker begins text processing. Inherited from SpellCheckerBase. |
| BeforeCheckWord | Occurs before a given word is exposed to a search algorithm. Inherited from SpellCheckerBase. |
| BeforeLoadDictionaries | Occurs when the spell checker starts loading dictionaries. Inherited from SpellCheckerBase. |
| CheckCompleteFormShowing | Occurs when the spell check is complete. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| FinishCheckingMainPart | Occurs when the selected part of the text is processed. Inherited from SpellCheckerBase. |
| NotInDictionaryWordFound | Occurs when a word being checked is not found in a dictionary. Inherited from SpellCheckerBase. |
| OptionsFormShowing | Occurs when the form used to specify the OptionsSpelling is about to be shown. |
| PopupMenuShowing | Occurs before a context menu is shown. |
| PrepareContextMenu | Obsolete. Occurs before a context menu is created. |
| PrepareSuggestions | Occurs when a misspelled word is found and a list of suggested replacements is created and sorted. Inherited from SpellCheckerBase. |
| RepeatedWordFound | Occurs when a word identical to the previous one is found. Inherited from SpellCheckerBase. |
| SpellingFormShowing | Occurs when the spelling form is about to be displayed. |
| UnhandledException | Occurs when an unhandled system exception fires. Inherited from SpellCheckerBase. |
| WordAdded | Occurs after a new word is added to the custom dictionary. Inherited from SpellCheckerBase. |
See Also
Feedback