Keyoti RapidSpell Web .NET Help Docs
RapidSpellWebLauncher Class
API DocumentationKeyoti.RapidSpellRapidSpellWebLauncher
Keyoti RapidSpell Web .NET
RapidSpell Web Launcher Control, shows a button that launches the spell checker.
Declaration Syntax
C#C#Visual BasicVisual BasicVisual C++Visual C++F#F#
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public class RapidSpellWebLauncher : WebControl, 
	INamingContainer, IPostBackEventHandler, IValidator
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public class RapidSpellWebLauncher : WebControl, 
	INamingContainer, IPostBackEventHandler, IValidator
<TypeConverterAttribute(GetType(ExpandableObjectConverter))> 
Public Class RapidSpellWebLauncher
	Inherits WebControl
	Implements INamingContainer, IPostBackEventHandler, IValidator
<TypeConverterAttribute(GetType(ExpandableObjectConverter))> 
Public Class RapidSpellWebLauncher
	Inherits WebControl
	Implements INamingContainer, IPostBackEventHandler, IValidator
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public ref class RapidSpellWebLauncher : public WebControl, 
	INamingContainer, IPostBackEventHandler, IValidator
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public ref class RapidSpellWebLauncher : public WebControl, 
	INamingContainer, IPostBackEventHandler, IValidator
[<TypeConverterAttribute(typeof(ExpandableObjectConverter))>]
type RapidSpellWebLauncher =  
    class
        inherit WebControl
        interface INamingContainer
        interface IPostBackEventHandler
        interface IValidator
    end
[<TypeConverterAttribute(typeof(ExpandableObjectConverter))>]
type RapidSpellWebLauncher =  
    class
        inherit WebControl
        interface INamingContainer
        interface IPostBackEventHandler
        interface IValidator
    end
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
RapidSpellWebLauncher()()()()
Creates a RapidSpell Launcher

AccessKey (Inherited from WebControl.)
Adapter (Inherited from Control.)
AddAttributesToRender(HtmlTextWriter) (Inherited from WebControl.)
AddedControl(Control, Int32) (Inherited from Control.)
AddParsedSubObject(Object) (Inherited from Control.)
AllowMixedCase
Whether to allow words spelt with mixed case, eg. "MIxEd".

ApplyStyle(Style) (Inherited from WebControl.)
ApplyStyleSheetSkin(Page) (Inherited from Control.)
AppRelativeTemplateSourceDirectory (Inherited from Control.)
Attributes (Inherited from WebControl.)
AutoLaunchWhenTextInvalid
Whether to start the spell check automatically when Validator==true and text has errors. See same in RapidSpellWebMultiple also.

BackColor (Inherited from WebControl.)
BeginRenderTracing(TextWriter, Object) (Inherited from Control.)
BindingContainer (Inherited from Control.)
BorderColor (Inherited from WebControl.)
BorderStyle (Inherited from WebControl.)
BorderWidth (Inherited from WebControl.)
BuildProfileTree(String, Boolean) (Inherited from Control.)
Button
The HtmlInputButton shown to the user, when clicked the spell checker starts.

ButtonImageMouseDown
The button image URL. This is for mouse down and is optional.

ButtonImageMouseOut
The button image URL. This is for mouse out (ie. not mouse over) and is optional.

ButtonImageMouseOver
The button image URL. This is for mouse over and is optional.

CallBack
The callBack URL or text box name.

CheckCompoundWords
Whether to check for compound words, setting this to true is essential for languages such as German which allow for compound words.

CheckTextBoxForErrors()()()()
Evaluates the text in the assigned text box for errors, this is called during validation. Returns true if there are errors, false if there are no errors or if the text box couldn't be accessed (see remarks).

ChildControlsCreated (Inherited from Control.)
ClearCachedClientID()()()() (Inherited from Control.)
ClearChildControlState()()()() (Inherited from Control.)
ClearChildState()()()() (Inherited from Control.)
ClearChildViewState()()()() (Inherited from Control.)
ClearEffectiveClientIDMode()()()() (Inherited from Control.)
ClientID (Inherited from Control.)
ClientIDMode (Inherited from Control.)
ClientIDSeparator (Inherited from Control.)
ClientSideObject
The name of the Javascript object variable representing the spell checker on the client side.

ConsiderationRange
The size 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 anyting.

Context (Inherited from Control.)
Controls (Inherited from Control.)
ControlStyle (Inherited from WebControl.)
ControlStyleCreated (Inherited from WebControl.)
CopyBaseAttributes(WebControl) (Inherited from WebControl.)
CorrectionNotifyListener
[PopUp only] The name of a Javascript function on this page which should be called {with the prototype funcName(int start, string oldword, string newword)} when a correction is made.

CreateChildControls()()()() (Inherited from Control.)
CreateControlCollection()()()() (Inherited from Control.)
CreateControlStyle()()()() (Inherited from WebControl.)
CreatePopUpWindow
Whether this control should create a pop-up window for the spell checker.

CssClass (Inherited from WebControl.)
DataBind()()()() (Inherited from Control.)
DataBind(Boolean) (Inherited from Control.)
DataBindChildren()()()() (Inherited from Control.)
DataBinding (Inherited from Control.)
DataItemContainer (Inherited from Control.)
DataKeysContainer (Inherited from Control.)
DesignMode (Inherited from Control.)
DictFile
(Optional) main dictionary (.dict) file on the server.

Dispose()()()() (Inherited from Control.)
Disposed (Inherited from Control.)
Enabled
Enabled state of the control.
(Overrides WebControl.Enabled.)
EnableOptions
Whether to provide 'options' functionality to the user.

EnableTheming
Theming is currently disabled. Support to be added in later versions.
(Overrides WebControl.EnableTheming.)
EnableUndo
Whether to provide 'undo' functionality to the user - when checking very large texts this may cause browser memory issues.

EnableViewState
Viewstate is always disabled.
(Overrides Control.EnableViewState.)
EndRenderTracing(TextWriter, Object) (Inherited from Control.)
EnsureChildControls()()()() (Inherited from Control.)
EnsureID()()()() (Inherited from Control.)
Equals(Object) (Inherited from Object.)
ErrorMessage
The error message to show the user when validation fails.

EscClientID
An escaped version of this ClientID suitable for use as Javascript variable names.

Events (Inherited from Control.)
FieldDisplayText
(Optional) The text to display in the spell checker to inform the user which text field is being checked.

Finalize()()()() (Inherited from Object.)
FindControl(String) (Inherited from Control.)
FindControl(String, Int32) (Inherited from Control.)
Finish
Fired when the spell check is finished AND PostBackOnFinish==true.

FinishClosesWindow
Whether to close the spell checker popup window when the 'Finish' button is clicked and CreatePopUpWindow==false.

FinishedListener
The name of a JavaScript function (without brackets) that should be called when pop up spell checking is finished (optional).

FinishedListenerInformState
Whether to inform the finished listener function of the way in which spell checking finished.

Focus()()()() (Inherited from Control.)
Font (Inherited from WebControl.)
ForeColor (Inherited from WebControl.)
GetDesignModeState()()()() (Inherited from Control.)
GetHashCode()()()() (Inherited from Object.)
GetRouteUrl(Object) (Inherited from Control.)
GetRouteUrl(String, Object) (Inherited from Control.)
GetRouteUrl(RouteValueDictionary) (Inherited from Control.)
GetRouteUrl(String, RouteValueDictionary) (Inherited from Control.)
GetType()()()() (Inherited from Object.)
GetUniqueIDRelativeTo(Control) (Inherited from Control.)
GuiLanguage
The UI language.

HasAttributes (Inherited from WebControl.)
HasChildViewState (Inherited from Control.)
HasControls()()()() (Inherited from Control.)
HasEvents()()()() (Inherited from Control.)
Height (Inherited from WebControl.)
ID (Inherited from Control.)
IdSeparator (Inherited from Control.)
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.

Init (Inherited from Control.)
IsChildControlStateCleared (Inherited from Control.)
IsEnabled (Inherited from WebControl.)
IsLiteralContent()()()() (Inherited from Control.)
IsTrackingViewState (Inherited from Control.)
IsValid
Whether the validator has identified an error or whether spell checking has already been forced by the validator.

IsViewStateEnabled (Inherited from Control.)
LanguageParser
The language parser to use, this should match the language of the main dictionary where possible.

LicenseKey Obsolete.
Whether to show the popup dialog at the end of the spell check.

Load (Inherited from Control.)
LoadControlState(Object) (Inherited from Control.)
LoadViewState(Object) (Inherited from WebControl.)
LoadViewStateByID (Inherited from Control.)
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.

MapPathSecure(String) (Inherited from Control.)
MemberwiseClone()()()() (Inherited from Object.)
MergeStyle(Style) (Inherited from WebControl.)
Modal
Whether the popup will be modal.

ModalHelperPage
The URL of the modal popup helper file (only has effect if Modal=true).

Mode
The mode to use RapidSpell Web in, can be "popup" or "separate".

NamingContainer (Inherited from Control.)
OnBubbleEvent(Object, EventArgs) (Inherited from Control.)
OnDataBinding(EventArgs) (Inherited from Control.)
OnFinish(EventArgs)
Called when the spell check is finished AND PostBackOnFinish==true.

OnInit(EventArgs)
Adds self to validators
(Overrides Control.OnInit(EventArgs).)
OnLoad(EventArgs) (Inherited from Control.)
OnPreRender(EventArgs)
See Control.OnPreRender.
(Overrides Control.OnPreRender(EventArgs).)
OnUnload(EventArgs)
Removes self from validators
(Overrides Control.OnUnload(EventArgs).)
OnValidatorNeedsText(ValidatorNeedsTextEventArgs)
Raises the ValidatorNeedsText event, allowing e.TextBoxText to be set with the text to validate.

OpenFile(String) (Inherited from Control.)
Page (Inherited from Control.)
Parent (Inherited from Control.)
PopUpWindowName
If this control doesn't create a pop-up window for the spell checker (and is in popup mode) this specifies the name of an existing window to put the spell checker in.

PostBackOnFinish
Whether to post back to the server when the spell check finishes.

PreRender (Inherited from Control.)
RaiseBubbleEvent(Object, EventArgs) (Inherited from Control.)
RaisePostBackEvent(String)
Method of IPostBackEventHandler that raises change events.

RapidSpellWebPage
The URL of the page holding the RapidSpellWeb control.

RemovedControl(Control) (Inherited from Control.)
Render(HtmlTextWriter) (Inherited from WebControl.)
RenderBeginTag(HtmlTextWriter) (Inherited from WebControl.)
RenderChildren(HtmlTextWriter) (Inherited from Control.)
RenderContents(HtmlTextWriter)
Renders this control.
(Overrides WebControl.RenderContents(HtmlTextWriter).)
RenderControl(HtmlTextWriter) (Inherited from Control.)
RenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
RenderEndTag(HtmlTextWriter) (Inherited from WebControl.)
RenderForDesign(HtmlTextWriter)
Renders this control for the design surface.

RenderingCompatibility (Inherited from Control.)
ResolveAdapter()()()() (Inherited from Control.)
ResolveClientUrl(String) (Inherited from Control.)
ResolveUrl(String) (Inherited from Control.)
RSMultipleID
The ID of the RapidSpellWebMultiple control managing multi text box checking.

SaveControlState()()()() (Inherited from Control.)
SaveViewState()()()() (Inherited from WebControl.)
SeparateHyphenWords
Whether to treat hyphenated (-) words as separate words, default is false.

SetDesignModeState(IDictionary) (Inherited from Control.)
SetRenderMethodDelegate(RenderMethod) (Inherited from Control.)
SetTraceData(Object, Object) (Inherited from Control.)
SetTraceData(Object, Object, Object) (Inherited from Control.)
ShowButton
Whether to show the launcher button (set to false to hide button/images). The client-side code will be written regardless.

ShowFinishedMessage
Whether to show the popup dialog at the end of the spell check.

ShowNoErrorsMessage
Whether to show the popup dialog stating there were no spelling errors.

Site (Inherited from Control.)
SkinID (Inherited from WebControl.)
SpellCheckText
The text displayed when the pop up is first opened.

SSLFriendly
Whether to run in SSL friendly mode, setting this to true prevents 'leaving secure site' warning messages in IE.

SSLFriendlyPage
The URL of the file to set in Iframes, this avoids SSL warnings.

Style (Inherited from WebControl.)
SuggestionsMethod
Suggestions method to use. Either PHONETIC_SUGGESTIONS or HASHING_SUGGESTIONS

SuggestSplitWords
Whether to look for connected words in suggestions.

SupportsDisabledAttribute (Inherited from WebControl.)
SuppressWarnings
Whether to suppress any warning messages (eg. that textbox couldn't be found).

TabIndex
The tab order of the control.
(Overrides WebControl.TabIndex.)
TagKey (Inherited from WebControl.)
TagName (Inherited from WebControl.)
TemplateControl (Inherited from Control.)
TemplateSourceDirectory (Inherited from Control.)
TextComponentInterface
The text box interface to be used.

TextComponentName
The text component Control ID to be checked on the form.

ToolTip (Inherited from WebControl.)
ToString()()()() (Inherited from Object.)
TrackViewState()()()() (Inherited from WebControl.)
UniqueID (Inherited from Control.)
Unload (Inherited from Control.)
UserDictionaryFile
The user dictionary file on the server for the user.

V2Parser
Whether to use parser version 2 - Set to false for backwards (pre v2.8) compatibility. This causes approx. 10-20% speed reduction for spelling error identification.

Validate()()()()
If Validator==true, this checks the text box for errors, and updates IsValid - note if there are errors but the spell check has already been forced this will set IsValid to true.

ValidateRequestMode (Inherited from Control.)
Validator
Whether to work as a validator.

ValidatorNeedsText
Fired when the validator is attempting to access the text of the textbox specified by TextComponentID.

ViewState (Inherited from Control.)
ViewStateIgnoresCase (Inherited from Control.)
ViewStateMode (Inherited from Control.)
Visible (Inherited from Control.)
WarnDuplicates
Whether to show duplicate words as errors (eg. "this is is an error").

Width (Inherited from WebControl.)
WindowHeight
Sets the window height (in pixels), when used in Mode=popup.

WindowWidth
Sets the window width (in pixels), when used in Mode=popup.

WindowX
Sets the window X position (in pixels), when used in Mode=popup.

WindowY
Sets the window Y position (in pixels), when used in Mode=popup.

Remarks
The minimum requirements to use this control are that TextComponentName and RapidSpellWebPage properties are set.

Eg.

 Copy imageCopy
<RapidSpellWeb:RapidSpellWebLauncher id="rapidSpellWebLauncher3" runat="server" 
                            TextComponentName="TextBox1" 
                            RapidSpellWebPage="RapidSpellCheckerPopUp.aspx">
                 </RapidSpellWeb:RapidSpellWebLauncher>
Inheritance Hierarchy
Object
Control
 WebControl
  RapidSpellWebLauncher

Assembly: Keyoti.RapidSpellWeb (Module: Keyoti.RapidSpellWeb.dll) Version: 6.4.25.331