RapidSpell Desktop As-You-Type Control, spell checks text boxes as the user types.
Declaration Syntax| C# | C# | Visual Basic | Visual Basic | Visual C++ | Visual C++ | F# | F# |
public class RapidSpellAsYouType : Component
public class RapidSpellAsYouType : Component
Public Class RapidSpellAsYouType Inherits Component
Public Class RapidSpellAsYouType Inherits Component
public ref class RapidSpellAsYouType : public Component
public ref class RapidSpellAsYouType : public Component
type RapidSpellAsYouType = class inherit Component end
type RapidSpellAsYouType = class inherit Component end
Members| All Members | Constructors | Methods | Properties | Fields | Events |
| Icon | Member | Description |
|---|---|---|
 | RapidSpellAsYouType()()()() | Default constructor. |
| RapidSpellAsYouType(IContainer) | Designer constructor. |
| AddMenuItem_Click()()()() |
Handles add menu item clicks.
|
 | AddMenuText | Add button text. |
| AddTextBoxBase(TextBoxBase) |
Add a text component to be checked to the collection.
|
| AddTextComponent(IAYTTextBox) |
Add a text component to be checked to the collection.
|
| AllowAnyCase | Whether to allow words spelt with incorrect case, eg. "africa", instead of "Africa", this is more relaxed than AllowMixedCase |
| AllowMixedCase | Whether to allow words spelt with mixed case, eg. "MIxEd" |
| AutoCheckAllTextComponentsUnder(Control) | When set, will check all text boxes under this control. NOTE this overrides the TextComponent(s) property. This method should be called once the form has loaded, otherwise the child controls in textComponentsUnder may not have been set. |
| AutoCorrectEnabled |
Whether to auto-correct common spelling/typographical mistakes (default is English errors).
|
| AutoCorrectionMap |
A map of common errors and their corrections.
|
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) |
| ChangeWordMenuItem_Click(String, Boolean) |
Handles change word menu clicks
|
| CheckAsYouType | Whether to spell check words as the user types/modifies text. |
| CheckCompoundWords | Whether to check for compound words, setting this to true is essential for languages such as German which
allow for compound words. |
| CheckDisabledTextBoxes |
Whether to spell check textboxes which are disabled.
|
 | checkFromPosition | Index of of character in text to check from. |
| CheckReadOnlyTextBoxes |
Whether to spell check textboxes which are readonly.
|
| ClearAllHighlights()()()() | Clears all spell check highlights (underlines) from the whole document. |
| ClearTextComponents()()()() |
Removes all text components from being spell checked.
|
| ConsiderationRange | Sets the factor for words to consider for suggestions,
lower values are faster but consider less words for suggestions. Default is 500.
If w <= 1 this method won't do anything.
|
| Container | Gets the IContainer that contains the Component. (Inherited from Component.) |
| ContextMenuStripEnabled | Whether to show the suggestion context menu through a ContextMenuStrip (true) or a ContextMenu (false). |
| 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.) |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) |
| DictFilePath | The file to be used as the main dictionary
(either a full file path, or the name of an embedded resource), if this is null then the built-in US English dictionary is used.
|
| Dispose()()()() | Releases all resources used by the Component. (Inherited from Component.) |
 | Dispose(Boolean) | Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.) |
 | Disposed | Occurs when the component is disposed by a call to the Dispose()()()() method. (Inherited from Component.) |
| Equals(Object) | (Inherited from Object.) |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) |
| Finalize()()()() | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.) |
| FindCapitalizedSuggestions | Whether to look for capitalized suggestions, note this will slow FindSuggestions down by about 7 times. |
| ForceCheckAll()()()() | Forces a check of the whole document. |
| FoundSpellingError | Fired when a spelling error is found. |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService()()()() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetNumberOfCurrentSpellingErrors(TextBoxBase) |
Returns the number of spelling errors currently in the tb, where tb is a textbox currently being spell checked.
|
| GetNumberOfCurrentSpellingErrors(IAYTTextBox) |
Returns the number of spelling errors currently in the tb, where tb is a textbox currently being spell checked.
|
| GetService(Type) | (Inherited from Component.) |
| GetSuggestionContextMenuInformation()()()() |
Gets information about the context menu that should be shown
|
| GetSuggestions()()()() | Returns suggestions menu items for the last right clicked word. Null/Nothing if none. |
| GetSuggestionsToolStripItems()()()() | Returns suggestions menu items as ToolStripItems for the last right clicked word. Null/Nothing if none. |
| GetTextComponents()()()() |
Gets the text components being spell checked.
|
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| GUILanguage | The language to show the UI in. |
| IgnoreAllMenuItem_Click()()()() |
Handles ignore all menu clicks.
|
| IgnoreAllMenuText | Ignore All button text. |
| IgnoreCapitalizedWords | Whether to ignore words with capital letters. |
| IgnoreIncorrectSentenceCapitalization | Whether to ignore incorrect sentence capitalization. |
| IgnoreInEnglishLowerCaseI |
Whether to ignore lower case 'i' characters in text. Set to false to flag as errors.
|
| IgnoreMenuText | Ignore button text. |
| IgnoreOnce(BadWord, IAYTTextBox) |
Ignores an instance of a bad word in the the textbox.
|
| IgnoreOnce(BadWord, TextBoxBase) |
Ignores an instance of a bad word in the the textbox.
|
| IgnoreOnceMenuItem_Click()()()() |
Handles ignore once menu clicks.
|
| 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/HTML tags, false by default. |
| IncludeUserDictionaryInSuggestions | Whether the user dictionary should be used in finding suggestions for misspelt words. |
| InitializeLifetimeService()()()() | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| 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. |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| NeedRapidSpellAsYouTypeAgent |
Fired when a new RapidSpellAsYouTypeAgent object is needed.
|
 | OnFoundSpellingError(FoundSpellingErrorEventArgs, Boolean) |
Raises the FoundSpellingError event
|
| OnNeedRapidSpellAsYouTypeAgent(NeedRapidSpellAsYouTypeAgentEventArgs) |
Fires NeedRapidSpellAsYouTypeAgent
|
| OnSpellContextMenuRequest(SpellContextMenuEventArgs) |
Fires event when a context menu is requested
|
| OnWordAdded(WordAddedEventArgs) |
Fires event when a word is added to the user dictionary
|
| OnWordChanged(WordChangedEventArgs) |
Fires event when a word is changed
|
| OnWordIgnored(WordIgnoredEventArgs) |
Fires event when a word is ignored
|
| OnWordsEntered(WordsEnteredEventArgs) |
Fires event when a word is entered into the textbox
|
| Options |
Object responsible for holding, loading and saving the user's spell check options.
|
| OptionsEnabled |
Whether to use user options.
|
| OptionsFileName |
The file name used to store the settings (by default in IsolatedStorage).
|
| OptionsPresenter |
Presenter for the user options form (IDialogViewOptions).
|
| OptionsStorageLocation |
Where the user's options are stored.
|
| RapidSpellChecker | The core spell checker object |
| RecheckTextOnPropertyChange |
Whether to recheck the text when properties that affect the spell check change.
|
| RemoveAllTextComponents()()()() |
Removes all text components to be checked from the collection.
|
| RemoveDuplicateWordText | Remove duplicate word text |
| RemoveTextBoxBase(TextBoxBase) |
Remove a text component to be checked from the collection.
|
| RemoveTextComponent(IAYTTextBox) |
Remove a text component to be checked from the collection.
|
| RepaintUnderlines()()()() | Repaints the underlines, this should be called if any changes are made to layout, such
as changes to font sizes, etc. |
| ResetIgnoredWords()()()() |
Resets all ignored words, so that the document will be rechecked.
|
| SeparateHyphenWords | Whether to treat hyphenated (-) words as separate words, default is false. |
| SetRepaintTimer(Int32) |
If set to a value other than 0, the underline painting will not be performed until the timer has elapsed. This has a resolution of 250 milliseconds.
|
| ShowAddMenuOption | Whether to show the Add option in the context menu. |
| ShowCutCopyPasteMenuOnTextBoxBase |
Whether to show a cut copy paste context menu on TextBoxBase controls being checked.
|
| ShowSuggestionsContextMenu | Whether to show a context menu with suggestions when a misspelt word is right clicked, has no effect on developer set context menu. |
| ShowSuggestionsWhenTextIsSelected | Whether to show the spelling context menu regardless of whether text is currently selected. |
| Site | (Inherited from Component.) |
| SpellCheckFinished | Fired when checking finishes |
| SpellCheckStarted | Fired when checking starts |
| SpellContextMenuRequest | Fired when a request is made (usually by a right click on an underlined word) for context menu |
| SuggestionsMethod | The suggestions method to use. |
| SuggestSplitWords | Whether to look for connected words in suggestions. |
| TextBoundary | The AdvancedTextBoundary class to use to parse words. |
| TextBoxBase | The TextBoxBase text box to check as the user types/modifies text. Do NOT set an AYTRichTextBox or AYTTextBox control here, use the TextComponent property instead. |
| TextComponent | The IAYTTextBox text box to check as the user types/modifies text. |
| TextComponents | The IAYTTextBox text boxes to check as the user types/modifies text. |
| ToString()()()() | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) |
| UnderlineColor | The underline color to use with mis-spelt words. |
| UnderlineStyle | The underline style to use with mis-spelt words. |
| UnignoreWord(BadWord, IAYTTextBox) |
Unignores an instance of a bad word in the textbox.
|
| UnignoreWord(BadWord, TextBoxBase) |
Unignores an instance of a bad word in the textbox.
|
| UnignoreWord(BadWord) |
Unignores an instance of a bad word in all textboxes.
|
| UpdateAllTextBoxes |
Whether to update all text boxes when ForceCheckAll is called, usually this should be true.
|
| UserDictionaryFile | The user dictionary file, if this file doesn't exist it will be created. |
| V2Parser | Whether to use parser version 2 - Set to false for backwards (pre v3.4) compatibility. |
| WarnDuplicates | Whether to show duplicate words as errors (eg. "this is is an error"). |
| WordAdded | Fired when word added to user dictionary |
| WordChanged | Fired when word changed |
| WordIgnored | Fired when word ignored |
| WordsEntered | Fired when words have been entered (typed or pasted). |
RemarksThis class works with IAYTTextBox interface classes. RichTextBox
and TextBox subclasses are included.
This class not only checks as the user types, but also follows any text modifying actions, such as;
Cut, paste, selection delete etc.
Inheritance Hierarchy| Object | |||
 | MarshalByRefObject | ||
| Component | ||
| RapidSpellAsYouType | ||
Assembly: Keyoti.RapidSpell.NET4 (Module: Keyoti.RapidSpell.NET4.dll) Version: 6.2.21.412