Controls the UI logic used for RapidSpellDialog forms.
Declaration Syntax| C# | C# | Visual Basic | Visual Basic | Visual C++ | Visual C++ | F# | F# |
public class RapidSpellGUIPresenter : Component, IUserInterfaceFormPresenter, IDialogViewEventHandler
public class RapidSpellGUIPresenter : Component, IUserInterfaceFormPresenter, IDialogViewEventHandler
Public Class RapidSpellGUIPresenter Inherits Component Implements IUserInterfaceFormPresenter, IDialogViewEventHandler
Public Class RapidSpellGUIPresenter Inherits Component Implements IUserInterfaceFormPresenter, IDialogViewEventHandler
public ref class RapidSpellGUIPresenter : public Component, IUserInterfaceFormPresenter, IDialogViewEventHandler
public ref class RapidSpellGUIPresenter : public Component, IUserInterfaceFormPresenter, IDialogViewEventHandler
type RapidSpellGUIPresenter = class inherit Component interface IUserInterfaceFormPresenter interface IDialogViewEventHandler end
type RapidSpellGUIPresenter = class inherit Component interface IUserInterfaceFormPresenter interface IDialogViewEventHandler end
Members| All Members | Constructors | Methods | Properties | Fields | Events |
| Icon | Member | Description |
|---|---|---|
 | RapidSpellGUIPresenter()()()() | Construct this GUI component - this will NOT open a new Form, call Check to do that. |
 | active | The state of this GUI. It can be either active (user is using it) or inactive (user focus is elsewhere). |
 | AddButtonText | Add button text. |
 | AddWord()()()() |
Adds the current bad word to the user dictionary. |
| AllOperationScope |
The scope that ignore-all/change-all should have.
|
| CancelButtonText | Cancel button text. |
| Cancelled | Whether the spell check has been cancelled. |
 | CanRaiseEvents | (Inherited from Component.) |
| ChangeAll()()()() | Called when user wants to change all instances of current bad word to selected word |
| ChangeAllButtonText | Change All button text. |
| ChangeButtonText | Change button text. |
| ChangeWord()()()() | User wants to change current bad word to selected word |
| Check()()()() | Bring up the spell checker Form and start checking the component set by SetTextComponentToCheck. |
| 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)
|
| checkingSelection | The state of this GUI. It can be either active (user is using it) or inactive (user focus is elsewhere). |
| CheckingSpellingText | Checking spelling text |
| Close()()()() | Closes the form if open. |
| 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.
|
| Container | (Inherited from Component.) |
 | CreateDialogView |
Indicates that a new IDialogView has been 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.
|
| CreateObjRef(Type) | (Inherited from MarshalByRefObject.) |
| DesignMode | (Inherited from Component.) |
| DialogTitleText | Dialog title text |
| DialogView |
The IDialogView instance to use for the UI.
|
| DialogView_AddButtonClick(Object, EventArgs) |
Handles IDialogView event
|
| DialogView_CancelButtonClick(Object, EventArgs) |
Handles IDialogView event
|
| DialogView_ChangeAllButtonClick(Object, EventArgs) |
Handles IDialogView event
|
| DialogView_ChangeButtonClick(Object, EventArgs) |
Handles IDialogView event
|
| DialogView_Closing(Object, CancelEventArgs) |
Handles IDialogView event
|
| DialogView_IgnoreAllButtonClick(Object, EventArgs) |
Handles IDialogView event
|
| DialogView_IgnoreButtonClick(Object, EventArgs) |
Handles IDialogView event
|
| DialogView_Load(Object, EventArgs) |
Handles IDialogView event
|
| DialogView_OptionsButtonClick(Object, EventArgs) |
Handles IDialogView event
|
| DialogView_QueryTextBoxEnter(Object, EventArgs) |
Handles IDialogView event
|
| DialogView_QueryTextBoxTextChanged(Object, EventArgs) |
Handles IDialogView event
|
| DialogView_SuggestionsListDoubleClick(Object, EventArgs) |
Handles IDialogView event
|
| DialogView_UndoButtonClick(Object, EventArgs) |
Handles the Undo button click
|
| DialogView_UserNeedsSuggestionsChanged(Object, EventArgs) |
Handles IDialogView event
|
 | DialogViewOptionsPresenter_CreateDialogViewOptions(Object, CreateDialogViewOptionsEventArgs) |
Handles IDialogView event
|
| DialogViewOptionsPresenter_CreateDialogViewUserDictionaryEdit(Object, CreateDialogViewUserDictionaryEditEventArgs) |
Handles IDialogView event
|
| DictFilePath | Optional file path to the main dictionary .dict file to use. |
| Dispose()()()() |
Disposes of resources
|
| Dispose(Boolean) |
Frees up resources
(Overrides Component.Dispose(Boolean).) |
| DisposeAtEnd | Whether to dispose of this form when spell check is finished. |
| Disposed | (Inherited from Component.) |
| End()()()() | Called when finished checking document, brings up spelling check is complete message. |
| Equals(Object) | (Inherited from Object.) |
| Events | (Inherited from Component.) |
| Finalize()()()() | (Inherited from Component.) |
| FindCapitalizedSuggestions | Whether to look for capitalized suggestions, note this will slow FindSuggestions down by about 7 times. |
| FindingSuggestionsLabelText | Finding suggestions label text. |
| findSuggestions | Whether this should look up suggestions for misspelt words or not. |
| FindSuggestionsLabelText | Find suggestions label text. |
| FindWordEnd(Int32) |
Returns the end of the word that fromPos is in.
|
| FinishedCheckingSelectionPopUpText | Finished checking selection dialog text |
| FinishedCheckingSelectionPopUpTitle | Finished checking selection dialog title |
| FocusGained(Object, EventArgs) | Called when objects whose focus this is listening to gain focus. |
| fromPosition | Where the user wants to check from in the document |
| GenerateSentenceParts(Int32, Int32) |
Finds the sentence up to a point and the sentence after a point
|
| GetHashCode()()()() | (Inherited from Object.) |
| GetLifetimeService()()()() | (Inherited from MarshalByRefObject.) |
| GetService(Type) | (Inherited from Component.) |
| GetType()()()() | (Inherited from Object.) |
| GUILanguage | The language to show the UI in. |
| guiShowing |
Whether the gui is currently showing
|
| Ignore()()()() | Ignore the current bad word. |
| IgnoreAll()()()() |
Ignores all occurrences of this word. |
| IgnoreAllButtonText | Ignore All button text. |
| IgnoreButtonText | Ignore 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.
|
| 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. |
| InDictionaryLabelText | In dictionary label text |
| InitializeLifetimeService()()()() | (Inherited from MarshalByRefObject.) |
| IsDialogViewCreated()()()() |
Whether a dialog view has already been created.
|
| IsDisposed |
Whether the IDialogView is disposed of
|
| LanguageParser | The type of language parsing to use. |
| Load |
Fired when the DialogView loads.
|
| Location | Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. |
| 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. |
| MakeChange()()()() | Changes the current bad word for one selected from the suggestions list or entered in the query pane
returns the word used. |
| MakeChange(Boolean) | Changes the current bad word for one selected from the suggestions list or entered in the query pane
returns the word used. |
| MakeChange(Boolean, String, Boolean) | Changes the current bad word for one selected from the suggestions list or entered in the query pane
returns the word used. |
| MaximumContextualWords |
The maximum number of words to show the user in the sentence around misspelled words.
|
| MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) |
| MemberwiseClone()()()() | (Inherited from Object.) |
| 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 modal dialog owner window.
|
| MoveCaretToWordEnd()()()() | Moves the caret to the end of the word the caret is in, or where it is if not on a word. |
| MoveCaretToWordStart()()()() | Moves the caret to the start of the word the caret is in, or where it is if not on a word. |
| 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.
|
| OnCreateDialogView(CreateDialogViewEventArgs) |
Fires the CreateDialogView event.
|
| OnSuggestionsDoubleClick(Object, EventArgs) | Called when the user double clicks on a suggestion. |
| OnUndone(UndoEventArgs) |
Raises the Undone event
|
| OnUserQuery(UserQueryEventArgs) |
Fires the user query event
|
| 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).
|
| ProceedFromEnd()()()() | Decides what to do once reached end of required text check region |
| QueryTextBoxMultiline | Whether 'not in dictionary' text box is multiline or single line. |
| Ready |
Fired when ready to proceed with first query.
|
| RecheckDocumentRequest |
Fired when document recheck is requested
|
| Remove()()()() | Safely frees up resources. |
| RemoveDuplicateWordText | Remove duplicate word text |
| Resume()()()() | Looks for next bad word |
| ResumeButtonText | Resume button text |
| SelectText(BadWord) | Selects a bad word in the text component |
| SeparateHyphenWords | Sets whether to treat hyphenated (-) words as separate words, default is false. |
| SetDisposeAtEnd(Boolean) | Sets whether this will dispose of self at the end of the spell check. |
| SetIgnoreOnceBadWords(ArrayList) |
Provide a list of BadWord objects that have been ignored
|
| SetTextComponentToCheck(TextBox) | Set the TextBox (WPF) that this GUI will spell check. |
| SetTextComponentToCheck(RichTextBox) | Set the RichTextBox (WPF) that this GUI will spell check. |
| SetTextComponentToCheck(ISpellCheckableTextComponent) | Sets the ISpellCheckableTextComponent that this GUI will spell check. |
| SetTextComponentToCheck(ISpellCheckableTextComponent2) | Sets the ISpellCheckableTextComponent2 that this GUI will spell check. |
| SetUITexts()()()() |
Applies the UI texts to the IDialogView
|
| ShouldEnableAddButton()()()() |
Determines if the Add button should be enabled
|
| ShowContextSentence |
Whether to show the query in context of it's sentence/line.
|
| ShowFinishedMessageBox | Whether a message box should be opened when the spell check is complete. |
| showMessageBoxAtEnd | |
| Site | (Inherited from Component.) |
| SpellCheckFinished | Fired when checking finishes |
| SpellCheckStarted | Fired when checking starts |
| subFromPosition | To check from and to positions that are wrapped, need to do in 2 steps
check from subFromPosition ( = fromPosition) -> subToPosition (= doc end)
and then
check from subFromPosition (= 0) -> subToPosition (= toPosition) |
| subToPosition | To check from and to positions that are wrapped, need to do in 2 steps
check from subFromPosition ( = fromPosition) -> subToPosition (= doc end)
and then
check from subFromPosition (= 0) -> subToPosition (= toPosition) |
| SuggestionsKeyboardText | Suggestions label text when in keyboard mode |
| SuggestionsLabelText | Suggestions label text |
| SuggestionsMethod |
The suggestions method to use.
|
| SuggestSplitWords | Whether to look for connected words in suggestions. |
| TextBoundary | The AdvancedTextBoundary class to use to parse words. |
| TextBox |
The text box instance that this is working with, the actual type depends on whether the TextBoxBaseToCheck property or ThirdPartyTextComponentToCheck property was set.
|
| theBadWord | |
| theSpellChecker | The spell checker component being used |
| theTextComponent |
The text component being checked
|
| toPosition | Where the user wants to check to |
| ToString()()()() | (Inherited from Component.) |
| Undo()()()() |
Undoes the previous user operation.
|
| UndoButtonText |
Undo button text
|
| Undone |
Fired when an Undo occurs
|
| UserDictionary | Set the user dictionary object. |
| UserDictionaryFile | Set the user dictionary file, if this file doesn't exist it will be created. |
| 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 |
| Wrap()()()() | Wraps the checker to start at beginning of doc |
| wrapped |
RemarksThis class contains no UI elements, instead they are held in it's DialogView property.
To customize the UI layout and/or behavior, consult the user guide section "Custom RapidSpellDialog User Interface", which outlines how
to use the various "Create*" events in RapidSpellDialog to return custom instances of this class or implementations of IDialogView.
Inheritance Hierarchy| Object | |||
 | MarshalByRefObject | ||
| Component | ||
| RapidSpellGUIPresenter | ||
Assembly: Keyoti4.RapidSpell.WPF (Module: Keyoti4.RapidSpell.WPF.dll) Version: 3.1.16.1214