RapidSpell Desktop Dialog Control, this convenience control provides design time support for RapidSpellGUI and multiple text box support.
Declaration Syntax| C# | C# | Visual Basic | Visual Basic | Visual C++ | Visual C++ | F# | F# |
public class RapidSpellDialog : Component
public class RapidSpellDialog : Component
Public Class RapidSpellDialog Inherits Component
Public Class RapidSpellDialog Inherits Component
public ref class RapidSpellDialog : public Component
public ref class RapidSpellDialog : public Component
type RapidSpellDialog = class inherit Component end
type RapidSpellDialog = class inherit Component end
Members| All Members | Constructors | Methods | Properties | Events | |
| Icon | Member | Description |
|---|---|---|
 | RapidSpellDialog()()()() | Default constructor. |
| RapidSpellDialog(IContainer) | Designer constructor. |
| AddTextComponent(TextBoxBase) |
Adds a TextBoxBase (TextBox, RichTextBox and derivatives) to be checked.
|
| AddTextComponent(ISpellCheckableTextComponent) |
Adds an ISpellCheckableTextComponent to be checked.
|
 | AllOperationScope |
The scope that ignore-all/change-all should have.
|
| 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" |
| AlwaysShowDialog | Whether to show dialog even when there are no errors in the text box. If set to false causes a spell check before opening the dialog, if there are no errors a message box appears instead of the dialog. |
| BackColor | Gets or sets the background color for the control. |
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) |
| Check()()()() | Bring up the spell checker dialog and start checking the component set to check. |
| 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.
|
| CheckerEngine | The checker engine to use, this object must implement the ICheckerEngine interface, allows
customization or replacement of the spell checker. |
| CheckFromStartOfTextOnMultiples | Whether to check each textbox from the start of the text when working with multiple textboxes. |
| CheckReadOnlyTextBoxes |
Whether to spell check textboxes which are readonly.
|
| ClearTextComponents()()()() | Obsolete.
Removes all text components from being spell checked.
|
| Close()()()() | Close the spell checker dialog window, if open. |
| 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.) |
| ControlBox | Whether a control box is displayed in the caption bar of the form. |
 | CreateDialogView |
Fired when an IDialogView is being created. Allows for customization
|
| CreateDialogViewOptions |
Fired when an IDialogViewOptions is being created. Allows for customization
|
| CreateDialogViewUserDictionaryEdit |
Indicates that a new IDialogViewUserDictionaryEdit is being created, also provides chance to override
the default IDialogViewUserDictionaryEdit.
|
| CreateDialogViewUserDictionarySelect |
Indicates that a new IDialogViewUserDictionarySelect is being created, also provides chance to override
the default IDialogViewUserDictionarySelect.
|
| 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.) |
| CreateUserInterfaceFormPresenter |
Fired when an IUserInterfaceFormPresenter is being created. Allows for customization
|
| 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(Boolean) | Disposes of unmanaged resources. (Overrides Component.Dispose(Boolean).) |
| Dispose()()()() | Releases all resources used by the Component. (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. |
| ForeColor | Gets or sets the foreground color for the control. |
| FormBorderStyle | Specifies the border styles for the dialog form. |
| 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.) |
| GetService(Type) | (Inherited from Component.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| GUILanguage | The language to show the UI in. |
| Icon | Gets or sets the icon for the form.. |
| 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.
|
| 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. |
| Location | Where to position dialog the first time it is opened. |
| 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. |
| MdiParent | Gets or sets the current multiple document interface (MDI) parent form of this form. |
| 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.) |
| MinimizeBox | Whether the minimize button is displayed in the caption bar of the form. |
| Modal | Whether the spell checker will run modally. (Modal operation blocks the parent form) |
| ModalAutoDispose | When running modally, determines if the dialog will be disposed of when spell check finishes. |
| ModalOwner | The owner of the checker form, when it's viewed modally. |
| NumberSuggestionList |
Whether to number the items in the suggestion list, for quick user selection.
|
| OnCreateDialogView(CreateDialogViewEventArgs) |
Raises event
|
| OnCreateDialogViewOptions(CreateDialogViewOptionsEventArgs) |
Raises event
|
| OnCreateDialogViewUserDictionaryEdit(CreateDialogViewUserDictionaryEditEventArgs) |
Fires the CreateDialogViewUserDictionaryEdit event.
|
| OnCreateDialogViewUserDictionarySelect(CreateDialogViewUserDictionarySelectEventArgs) |
Raises event
|
| OnCreateUserInterfaceFormPresenter(CreateUserInterfaceFormPresenterEventArgs) |
Raises event
|
| OnSpellCheckFinishedTextBox(TextBoxSpellCheckEventArgs) |
Raises event
|
| OnSpellCheckStartedTextBox(TextBoxSpellCheckEventArgs) |
Raises event
|
 | OnWordAdded(Object, WordAddedEventArgs) |
Fires WordAdded event
|
| OnWordChanged(Object, WordChangedEventArgs) |
Fires WordChanged event
|
| OnWordChanging(Object, WordChangedEventArgs) |
Fires WordChanging event
|
| OnWordIgnored(Object, WordIgnoredEventArgs) |
Fires WordIgnored event
|
| 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.
|
| Parent | Gets or sets the parent of the dialog form. |
| QueryTextBoxMultiline | Whether 'not in dictionary' text box is multiline or single line. |
| Ready |
Fired when ready to proceed with first query.
|
| RecheckDocumentRequest |
Fired when the text should be rechecked
|
| RemoveAllTextComponents()()()() |
Removes all text components from being spell checked.
|
| RemoveTextComponent(TextBoxBase) |
Removes a TextBoxBase (TextBox, RichTextBox and derivatives) to be checked.
|
| RemoveTextComponent(ISpellCheckableTextComponent) |
Removes an ISpellCheckableTextComponent to be checked.
|
| ResetIgnoredWords()()()() |
Resets all ignored words, so that the document will be rechecked.
|
| SeparateHyphenWords | Whether to treat hyphenated (-) words as separate words, default is false. |
| ShowContextSentence |
Whether to show the query in context of it's sentence/line.
|
| ShowFinishedBoxAtEnd | Whether to show the spell check complete dialog box at the end, true by default. |
| ShowInTaskbar | Gets or sets a value indicating whether the form is displayed in the Windows taskbar. |
| ShowOptionForCheckAsYouType | Whether to show the 'check as you type' option check box in the options form. |
| ShowOptionForMultipleUserDictionaries | Whether to allow the user to add/remove additional user dictionaries in the options form, the user is not permitted to remove the user dictionary assigned via code. |
| ShowOptionsButton | Whether to show the options button. |
| ShowUndoButton | Whether to show the undo button. |
| Site | (Inherited from Component.) |
| SizeGripStyle | Style of the size grip to display in the lower-right corner of the form |
| SpellCheckFinished | Fired when checking finishes |
| SpellCheckFinishedTextBox | Fired when spell check starts on a text box (used in multiple text box checking situations) |
| SpellCheckStarted | Fired when checking starts |
| SpellCheckStartedTextBox | Fired when spell check starts on a text box (used in multiple text box checking situations) |
| StartPosition | Gets or sets the starting position of the form at run time |
| SuggestionsMethod | The suggestions method to use. |
| SuggestSplitWords | Whether to look for connected words in suggestions. |
| TextBoxBasesToCheck | Array of TextBoxBases this GUI will spell check. |
| TextBoxBaseToCheck | The TextBoxBase (eg; TextBox etc) that this GUI will spell check. |
| Texts | The UI texts. |
| ThirdPartyTextComponentsToCheck | Array of ISpellCheckableTextComponent this GUI will spell check. |
| ThirdPartyTextComponentToCheck | The 3rd Party Component that this GUI will spell check. |
| TopLevel | Whether to display the form as a top-level window. |
| TopMost | Whether the form is 'always on top'. |
| ToString()()()() | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) |
| Undone |
Fired when an Undo occurs
|
| UserDictionaryFile | The user dictionary file, if this file doesn't exist it will be created. |
| UserInterfaceFormPresenter | The presenter (eg. RapidSpellGUIPresenter) currently in use, may be null/Nothing if not created yet. |
| UserQuery |
Indicates that the user is being queried on a spelling error.
|
| 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 a word is changed |
| WordChanging | Fired before a word is changed |
| WordIgnored | Fired when word ignored |
| WordRemoved | Fired when a word is removed from user dictionary. |
Inheritance Hierarchy| Object | |||
 | MarshalByRefObject | ||
| Component | ||
| RapidSpellDialog | ||
Assembly: Keyoti.RapidSpell.NET4 (Module: Keyoti.RapidSpell.NET4.dll) Version: 6.2.21.412