Interface requirements for a dialog based UI form.
Declaration Syntax| C# | C# | Visual Basic | Visual Basic | Visual C++ | Visual C++ | F# | F# |
public interface IUserInterfaceFormPresenter : IDialogViewEventHandler
public interface IUserInterfaceFormPresenter : IDialogViewEventHandler
Public Interface IUserInterfaceFormPresenter Inherits IDialogViewEventHandler
Public Interface IUserInterfaceFormPresenter Inherits IDialogViewEventHandler
public interface class IUserInterfaceFormPresenter : IDialogViewEventHandler
public interface class IUserInterfaceFormPresenter : IDialogViewEventHandler
type IUserInterfaceFormPresenter = interface interface IDialogViewEventHandler end
type IUserInterfaceFormPresenter = interface interface IDialogViewEventHandler end
Members| All Members | Methods | Properties | Events | ||
| Icon | Member | Description |
|---|---|---|
 | AddButtonText | Add button text. |
| AllOperationScope |
The scope that ignore-all/change-all should have.
|
| CancelButtonText | Cancel button text. |
| Cancelled | Whether the spell check has been cancelled. |
| ChangeAllButtonText | Change All button text. |
| ChangeButtonText | Change button text. |
 | Check()()()() | Bring up the spell checker Form and start checking the component set by SetTextComponentToCheck. |
| Check(TextBoxBase) | Bring up the spell checker Form and start checking the TextBoxBase textComponent. |
| Check(ISpellCheckableTextComponent) | Bring up the spell checker Form and start checking the TextBoxBase textComponent. |
| CheckCompletePopUpText | Check complete pop up text |
| CheckCompletePopUpTitle | Check complete pop up title |
| CheckCompoundWords | Whether to check for compound words, setting this to true is essential for languages such as German which
allow for compound words. |
| CheckerEngine | The checker engine to use, this object must implement the ICheckerEngine interface, allows
customization or replacement of the spell checker. |
| CheckFromStartOfText |
Whether to check from the start of the text (true) or whereever the cursor is (false)
|
| CheckingSpellingText | Checking spelling text |
| ConsiderationRange | The factor for words to consider for suggestions,
lower values are faster but consider less words for suggestions. Default is 80.
If w <= 1 this method won't do anything.
|
 | CreateDialogView |
Indicates that a new IDialogView is being created, also provides chance to override
the default IDialogView.
|
| CreateDialogViewOptions |
Indicates that a new IDialogViewOptions is being created, also provides chance to override
the default IDialogViewOptions.
|
| 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.
|
| DialogTitleText | Dialog title text |
| DialogView |
The IDialogView to use
|
| DialogView_AddButtonClick(Object, EventArgs) |
The add button was clicked
(Inherited from IDialogViewEventHandler.) |
| DialogView_CancelButtonClick(Object, EventArgs) |
The cancel button was clicked
(Inherited from IDialogViewEventHandler.) |
| DialogView_ChangeAllButtonClick(Object, EventArgs) |
The change-all button was clicked
(Inherited from IDialogViewEventHandler.) |
| DialogView_ChangeButtonClick(Object, EventArgs) |
The change button was clicked
(Inherited from IDialogViewEventHandler.) |
| DialogView_Closing(Object, CancelEventArgs) |
The view is closing
(Inherited from IDialogViewEventHandler.) |
| DialogView_IgnoreAllButtonClick(Object, EventArgs) |
The ignore all button was clicked
(Inherited from IDialogViewEventHandler.) |
| DialogView_IgnoreButtonClick(Object, EventArgs) |
The ignore button was clicked
(Inherited from IDialogViewEventHandler.) |
| DialogView_Load(Object, EventArgs) |
The view has loaded
(Inherited from IDialogViewEventHandler.) |
| DialogView_OptionsButtonClick(Object, EventArgs) |
The options button was clicked
(Inherited from IDialogViewEventHandler.) |
| DialogView_QueryTextBoxEnter(Object, EventArgs) |
Query textbox has been entered
(Inherited from IDialogViewEventHandler.) |
| DialogView_QueryTextBoxTextChanged(Object, EventArgs) |
The text in the query textbox changed
(Inherited from IDialogViewEventHandler.) |
| DialogView_SuggestionsListDoubleClick(Object, EventArgs) |
The user double clicked on a suggested item. Not mandatory to implement.
(Inherited from IDialogViewEventHandler.) |
| DialogView_UndoButtonClick(Object, EventArgs) |
The undo button was clicked
(Inherited from IDialogViewEventHandler.) |
| DialogView_UserNeedsSuggestionsChanged(Object, EventArgs) |
User has checked the "Find Suggestions" checkbox (if it exists).
(Inherited from IDialogViewEventHandler.) |
| DictFilePath | Optional file path to the main dictionary .dict file to use. |
| Dispose()()()() |
Dispose of resources
|
| DisposeAtEnd | Whether to dispose of this form when spell check is finished. |
| FindCapitalizedSuggestions | Whether to look for capitalized suggestions, note this will slow FindSuggestions down by about 7 times. |
| FindingSuggestionsLabelText | Finding suggestions label text. |
| FindSuggestionsLabelText | Find suggestions label text. |
| FinishedCheckingSelectionPopUpText | Finished checking selection dialog text |
| FinishedCheckingSelectionPopUpTitle | Finished checking selection dialog title |
| GetIncludeUserDictionaryInSuggestions()()()() | Gets whether the user dictionary should be used in finding suggestions for misspelt words. |
| GetSeparateHyphenWords()()()() | Gets whether to treat hyphenated (-) words as separate words, default is false. |
| GUILanguage | The language to show the UI in. |
| IgnoreAllButtonText | Ignore All button text. |
| IgnoreButtonText | Ignore button text. |
| IgnoreCapitalizedWords | Sets 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.
|
| IgnoreWordsWithDigits | Whether to ignore words with numbers in them (eg. A10 or 7-11). |
| IgnoreXML | Whether to ignore XML/HTML tags, false by default. |
| InDictionaryLabelText | In dictionary label text |
| IsDialogViewCreated()()()() |
Whether a dialog view has already been created.
|
| IsShowFinishedMessageBox()()()() | Returns whether a message box should be opened when the spell check is complete. |
| LanguageParser | The type of language parsing to use. |
| Load |
Fired when the DialogView loads.
|
| 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. |
| MaximumContextualWords |
The maximum number of words to show the user in the sentence around misspelled words.
|
| ModalAutoDispose | When running modally, determines if the dialog will be disposed of when spell check finishes. |
| ModalMode | Whether the spell checker will run modally. (Modal operation blocks the parent form) |
| ModalOwner | The owner window when used modally. |
| NoSuggestionsText | No suggestions found text |
| NotInDictionaryLabelText | Not in dictionary label text |
| NumberSuggestionList |
Whether to number the items in the suggestion list, for quick user selection.
|
| Options |
Object responsible for holding, loading and saving the user's spell check options.
|
| OptionsButtonText |
Options button text
|
| OptionsPresenter |
Presenter for the user options form (IDialogViewOptions).
|
| Ready |
Fired when ready to proceed with first query.
|
| RecheckDocumentRequest |
Fired when the text should be rechecked
|
| Remove()()()() | Safely frees up resources. |
| RemoveDuplicateWordText | Remove duplicate word text |
| ResumeButtonText | Resume button text |
| SetIgnoreOnceBadWords(ArrayList) |
Provide a list of BadWord objects that have been ignored
|
| SetIncludeUserDictionaryInSuggestions(Boolean) | Sets whether the user dictionary should be used in finding suggestions for misspelt words. |
| SetSeparateHyphenWords(Boolean) | Sets whether to treat hyphenated (-) words as separate words, default is false. |
| SetShowFinishedMessageBox(Boolean) | Sets whether a message box should be opened when the spell check is complete. |
| SetTextComponentToCheck(TextBoxBase) | Set the TextBoxBase (eg; TextBox etc) that this GUI will spell check. |
| SetTextComponentToCheck(ISpellCheckableTextComponent) | Sets the ISpellCheckableTextComponent that this GUI will spell check. |
| SetUserDictionary(UserDictionary) | Set the user dictionary object. |
| SetUserDictionaryFile(String) | Set the user dictionary file, if this file doesn't exist it will be created. |
| ShowContextSentence |
Whether to show the query in context of it's sentence/line.
|
| SpellCheckFinished | Fired when checking finishes |
| SpellCheckStarted | Fired when checking starts |
| SuggestionsLabelText | Suggestions label text |
| SuggestionsMethod | Sets the suggestions method to use. Either PHONETIC_SUGGESTIONS or HASHING_SUGGESTIONS
|
| SuggestSplitWords | Whether to look for connected words in suggestions. |
| UndoButtonText |
Undo button text
|
| Undone |
Fired when an Undo occurs
|
| UserQuery |
Indicates that the user is being queried on a spelling error.
|
| 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 |
| WordChanging | Fired before a word is changed |
| WordIgnored | Fired when word ignored |
RemarksImplement this interface in custom UI objects that you wish to plug-in to RapidSpellDialog.
Note: Sub-classes of RapidSpellGUI implement this interface by inheritance (automatically).
Assembly: Keyoti.RapidSpell.NET4 (Module: Keyoti.RapidSpell.NET4.dll) Version: 6.2.21.412