RapidSpell Web Inline Control, shows a button that launches the inline highlight spell checker.
Declaration Syntax| C# | C# | Visual Basic | Visual Basic | Visual C++ | Visual C++ | F# | F# |
public class RapidSpellWInline : WebControl, IValidator, INamingContainer
public class RapidSpellWInline : WebControl, IValidator, INamingContainer
Public Class RapidSpellWInline Inherits WebControl Implements IValidator, INamingContainer
Public Class RapidSpellWInline Inherits WebControl Implements IValidator, INamingContainer
public ref class RapidSpellWInline : public WebControl, IValidator, INamingContainer
public ref class RapidSpellWInline : public WebControl, IValidator, INamingContainer
type RapidSpellWInline = class inherit WebControl interface IValidator interface INamingContainer end
type RapidSpellWInline = class inherit WebControl interface IValidator interface INamingContainer end
Members| All Members | Constructors | Methods | Properties | Events | |
| Icon | Member | Description |
|---|---|---|
 | RapidSpellWInline()()()() |
Creates a new instance
|
 | AccessKey | (Inherited from WebControl.) |
 | Adapter | (Inherited from Control.) |
 | AddAttributesToRender(HtmlTextWriter) | (Inherited from WebControl.) |
 | AddedControl(Control, Int32) | (Inherited from Control.) |
| AddMenuText | The text used for the Add menu item. |
| 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.) |
| AsYouTypeDelay | Number of milliseconds to wait after user stops typing before rechecking.
|
| 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. |
| ButtonText | The start text used for the button. |
| ButtonTextSpellChecking | The text used for the button while it is transitioning to 'spell mode'. |
| ButtonTextSpellMode | The text used for the button while it is in 'spell mode'. |
| ChangeAllText | The text used for the Change All sub menu item (only shown if ShowChangeAllItem == true). |
| ChangeButtonTextWithState | Whether to change the button state/text when in spell check mode.
|
| CheckAsYouType | Whether to spell check as the user types.
|
| CheckAsYouTypeOnPageLoad | Whether to run the spell check automatically when the page loads.
|
| 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.) |
| ClientFilesFolder | Where the client files are found, must be an absolute path to the directory containing the RapidSpell client files. |
| ClientFilesLocation | Whether to use the internal client files, or external files (for customization). |
| 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.) |
| CopyComputedStyleToOverlay | Whether to copy the computed style of the target text box to the overlay DIV. |
| CreateChildControls()()()() | (Inherited from Control.) |
| CreateControlCollection()()()() | (Inherited from Control.) |
| CreateControlStyle()()()() | (Inherited from WebControl.) |
| CssClass | (Inherited from WebControl.) |
| CssClassStaticOverlay | The CSS class given to the static-mode overlay DIV element which holds spelling errors in front of the text box. |
| 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.) |
| DoPreRender()()()() |
Helper
|
| DoubleClickSwitchesMode | Whether to change a static text box from checking to editing on double-click
|
| EditMenuText | The text used for the Edit... menu item. |
| Enabled | Enabled state of the control. (Overrides WebControl.Enabled.) |
| EnableTheming | Theming is currently disabled. Support to be added in later versions. (Overrides WebControl.EnableTheming.) |
| EnableViewState | Viewstate is always disabled. (Overrides Control.EnableViewState.) |
| EndRenderTracing(TextWriter, Object) | (Inherited from Control.) |
| EnsureChildControls()()()() | (Inherited from Control.) |
| EnsureID()()()() | (Inherited from Control.) |
| EnterEditModeWhenNoMoreErrors | Whether to automatically change a static text box from checking to editing when there are no more errors remaining.
|
| EnterStaticSpellCheckListener | The name of a JavaScript function (without brackets) that should be called when the text box is overlayed with the static spell check layer. |
| Equals(Object) | (Inherited from Object.) |
| ErrorMessage | The error message to show the user when validation fails. |
| Events | (Inherited from Control.) |
| Finalize()()()() | (Inherited from Object.) |
| FindControl(String) | (Inherited from Control.) |
| FindControl(String, Int32) | (Inherited from Control.) |
| FinishedListener | The name of a JavaScript function (without brackets) that should be called when spell checking is finished (optional). |
| 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.) |
| HideAddItemAlways | Whether to always hide the Add menu item - regardless of whether a user dictionary is specified. |
| ID | (Inherited from Control.) |
| IdSeparator | (Inherited from Control.) |
| IgnoreAllMenuText | The text used for the Ignore All menu item. |
| 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. |
| LeaveStaticSpellCheckListener | The name of a JavaScript function (without brackets) that should be called when the text box switches from the static spell check to edit mode. |
| 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.) |
| NamingContainer | (Inherited from Control.) |
| NoSpellErrorsText | The text used for the no spelling errors message. |
| NoSuggestionsMenuText | The text used for the No Suggestions menu item. |
| OnBubbleEvent(Object, EventArgs) | (Inherited from Control.) |
| OnDataBinding(EventArgs) | (Inherited from Control.) |
| OnInit(EventArgs) |
Registers required scripts.
(Overrides Control.OnInit(EventArgs).) |
| OnLoad(EventArgs) | (Inherited from Control.) |
| OnPreRender(EventArgs) |
Renders required client script
(Overrides Control.OnPreRender(EventArgs).) |
| OnUnload(EventArgs) |
On p
(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.) |
| PreRender | (Inherited from Control.) |
| RaiseBubbleEvent(Object, EventArgs) | (Inherited from Control.) |
| RapidSpellWInlineHelperPage | The URL of the page holding the RapidSpellWInlineHelper control. |
| RemovedControl(Control) | (Inherited from Control.) |
| RemoveDuplicateMenuText | The text used for the Remove Duplicate Words menu item. |
| Render(HtmlTextWriter) | (Inherited from WebControl.) |
| RenderBeginTag(HtmlTextWriter) | (Inherited from WebControl.) |
| RenderChildren(HtmlTextWriter) | (Inherited from Control.) |
| RenderContents(HtmlTextWriter) |
Render this control to the output parameter specified.
(Overrides WebControl.RenderContents(HtmlTextWriter).) |
| RenderControl(HtmlTextWriter) | (Inherited from Control.) |
| RenderControl(HtmlTextWriter, ControlAdapter) | (Inherited from Control.) |
| RenderEndTag(HtmlTextWriter) |
Renders the end of this tag
(Overrides WebControl.RenderEndTag(HtmlTextWriter).) |
| 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.) |
| ResponseTimeout | Number of seconds to pass before a message is shown to the user reporting a time-out. |
| ResponseTimeoutMessage | The message shown to the user in the event that the spell check request times-out. |
| RightClickForMenu | Whether to show the spelling context menu on right click instead of left click. |
| RSMultipleID | The ID of the RapidSpellWebMultiple control managing multi text box checking. |
| RunSpellCheckFunctionJS |
The Javascript function that should be registered on the page in order to run the spell check when the page loads.
|
| 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.) |
| ShowAddItemAlways | Whether to always show the Add menu item - regardless of whether a user dictionary is specified. |
| ShowButton | Whether to show the launcher button (set to false to hide button/images). The client-side code will be written regardless. |
| ShowChangeAllItem | Whether to show the Change All sub menu item. |
| ShowIgnoreAllMenuItem | Whether to show the Ignore All menu item. |
| ShowNoErrorsMessage | Whether to show the launcher button (set to false to hide button/images). The client-side code will be written regardless. |
| Site | (Inherited from Control.) |
| SkinID | (Inherited from WebControl.) |
| 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.) |
| TextComponentID |
The server/client (automatically detected) ID of the text box to work with.
|
| TextComponentInterface | The text box interface to be used. |
| 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. |
| UseXMLHTTPWhenAvailable |
Whether to use XMLHttpRequest (when it's available) to communicate with the server - typically this is best set true.
|
| 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.) |
Remarks The minimum requirements to use this control are that TextComponentID and RapidSpellWInlineHelperPage properties are set.
Eg.
 Copy | |
|---|---|
<RapidSpellWeb:RapidSpellWInline id="rapidSpellWInline1" runat="server" TextComponentID="TextBox1" RapidSpellWInlineHelperPage="rswiHelper.aspx"> </RapidSpellWeb:RapidSpellWInline> | |
Inheritance Hierarchy| Object | |||
 | Control | ||
| WebControl | ||
| RapidSpellWInline | ||
Assembly: Keyoti.RapidSpellWeb (Module: Keyoti.RapidSpellWeb.dll) Version: 6.4.25.331