Keyoti RapidSpell Desktop .NET API Docs
RapidSpellAsYouTypeAgent Class
APIKeyoti.RapidSpellRapidSpellAsYouTypeAgent
Keyoti RapidSpell Desktop .NET
Agent class that handles as-you-type for one text box.
Declaration Syntax
C#C#Visual BasicVisual BasicVisual C++Visual C++F#F#
public class RapidSpellAsYouTypeAgent
public class RapidSpellAsYouTypeAgent
Public Class RapidSpellAsYouTypeAgent
Public Class RapidSpellAsYouTypeAgent
public ref class RapidSpellAsYouTypeAgent
public ref class RapidSpellAsYouTypeAgent
type RapidSpellAsYouTypeAgent =  class end
type RapidSpellAsYouTypeAgent =  class end
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
RapidSpellAsYouTypeAgent(RapidSpellAsYouType)
New agent

AddMenuItem_Click()()()()
Handles add menu item clicks.

ChangeWordMenuItem_Click(String, Boolean)
Handles change word menu clicks

CheckAsYouType
Whether to spell check as the user types

checkFromPosition
Index of of character in text to check from.

checkToPosition
Index of character in text to check to.

ClearAllHighlights()()()()
Clears all spell check highlights (underlines) from the whole document (all text boxes).

DeHighlightText(BadWord)
Removes a highlight from a bad word in the text component

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
ForceCheckAll()()()()
Forces a check of the whole document.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetNumberOfCurrentSpellingErrors()()()()
Gets the current number of errors.

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.

GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
HighlightText(BadWord)
Highlights a bad word in the text component

IdentifyChange(TextChangeHint)
Returns the start and end indices in the current text of the changed text

IgnoreAllMenuItem_Click()()()()
Handles ignore all menu clicks.

IgnoreOnce(BadWord)
Ignores a word only once in the text

IgnoreOnceMenuItem_Click()()()()
Handles ignore once menu clicks.

IsInIgnorePos(Int32)
Whether to ignore words starting at this position.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnFocus(Object, EventArgs)
Called when text box is focused

OnKeyDown(Object, KeyEventArgs)
Called when user keys down

OnKeyPress(Object, KeyPressEventArgs)
Called when user keys down

OnKeyUp(Object, KeyEventArgs)
Called when user keys up

OnLeave(Object, EventArgs)
Called when user leaves a text box

OnMouseUp(Object, MouseEventArgs)
Called when mouse ups

OnPopup(Object, EventArgs)
Called when context menu is popped up.

OnPopUpClick(Object, EventArgs)
Called when the context menu is clicked, 'sender' must be the original MenuItem created by GetSuggestions, or by OnPopUp.

OnTextChanged(Object, EventArgs)
Called when text in text box changes

parent
RepaintUnderlines()()()()
Repaints the underlines, this should be called if any changes are made to layout, such as changes to font sizes, etc.

TextBoxBase
Gets the TextBoxBase instance (if applicable) that this object is spell checking.

TextComponent
The IAYTTextBox text box to check as the user types/modifies text.

theCurrentTextComponent
The current text component being checked (because it's in focus)

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UnignoreWord(BadWord)
Unignores a word.

Inheritance Hierarchy
Object
RapidSpellAsYouTypeAgent

Assembly: Keyoti.RapidSpell.NET4 (Module: Keyoti.RapidSpell.NET4.dll) Version: 6.2.21.412