RapidSpell Web Inline Control, shows a button that launches the inline highlight spell checker.
Declaration Syntax
C# | Visual Basic | Visual C++ |
public class RapidSpellWInline : WebControl, IValidator, INamingContainer
Public Class RapidSpellWInline _ Inherits WebControl _ Implements IValidator, INamingContainer
public ref class RapidSpellWInline : public WebControl, IValidator, INamingContainer
Members
All Members | Constructors | Methods | Properties | Events | |
Icon | Member | Description |
---|---|---|
RapidSpellWInline()()() |
Creates a new instance
| |
AccessKey |
Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from WebControl.) | |
Adapter |
Gets the browser-specific adapter for the control.
(Inherited from Control.) | |
AddAttributesToRender(HtmlTextWriter) |
Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.
(Inherited from WebControl.) | |
AddedControl(Control, Int32) | (Inherited from Control.) | |
AddMenuText | The text used for the Add menu item. | |
AddParsedSubObject(Object) |
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
(Inherited from Control.) | |
AllowMixedCase | Whether to allow words spelt with mixed case, eg. "MIxEd" | |
ApplyStyle(Style) |
Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
(Inherited from WebControl.) | |
ApplyStyleSheetSkin(Page) |
Applies the style properties defined in the page style sheet to the control.
(Inherited from Control.) | |
AppRelativeTemplateSourceDirectory |
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control.) | |
AsYouTypeDelay | Number of milliseconds to wait after user stops typing before rechecking.
| |
Attributes |
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from WebControl.) | |
AutoLaunchWhenTextInvalid | Whether to start the spell check automatically when Validator==true and text has errors. See same in RapidSpellWebMultiple also. | |
BackColor |
Gets or sets the background color of the Web server control.
(Inherited from WebControl.) | |
BindingContainer |
Gets the control that contains this control's data binding.
(Inherited from Control.) | |
BorderColor |
Gets or sets the border color of the Web control.
(Inherited from WebControl.) | |
BorderStyle |
Gets or sets the border style of the Web server control.
(Inherited from WebControl.) | |
BorderWidth |
Gets or sets the border width of the Web server control.
(Inherited from WebControl.) | |
BuildProfileTree(String, Boolean) |
Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.
(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 |
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control.) | |
ClearChildControlState()()() |
Deletes the control-state information for the server control's child controls.
(Inherited from Control.) | |
ClearChildState()()() |
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from Control.) | |
ClearChildViewState()()() |
Deletes the view-state information for all the server control's child controls.
(Inherited from Control.) | |
ClientFilesFolder | Where the client files are found, must be an absolute path to the directory containing the RapidSpell client files. | |
ClientID |
Gets the server control identifier generated by ASP.NET.
(Inherited from Control.) | |
ClientIDSeparator |
Gets a character value representing the separator character used in the ClientID property.
(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 |
Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control.) | |
Controls |
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from Control.) | |
ControlStyle |
Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from WebControl.) | |
ControlStyleCreated |
Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
(Inherited from WebControl.) | |
CopyBaseAttributes(WebControl) |
Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
(Inherited from WebControl.) | |
CopyComputedStyleToOverlay | Whether to copy the computed style of the target text box to the overlay DIV. | |
CreateChildControls()()() |
Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.
(Inherited from Control.) | |
CreateControlCollection()()() |
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from Control.) | |
CreateControlStyle()()() |
Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers.
(Inherited from WebControl.) | |
CssClass |
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
(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()()() |
Binds a data source to the invoked server control and all its child controls.
(Inherited from Control.) | |
DataBind(Boolean) |
Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.
(Inherited from Control.) | |
DataBindChildren()()() |
Binds a data source to the server control's child controls.
(Inherited from Control.) | |
DataBinding |
Occurs when the server control binds to a data source.
(Inherited from Control.) | |
DesignMode |
Gets a value indicating whether a control is being used on a design surface.
(Inherited from Control.) | |
DictFile | (Optional) main dictionary (.dict) file on the server. | |
Dispose()()() |
Enables a server control to perform final clean up before it is released from memory.
(Inherited from Control.) | |
Disposed |
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
(Inherited from Control.) | |
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 |
Gets or sets a value indicating whether themes apply to this control.
(Inherited from WebControl.) | |
EnableViewState | Viewstate is always disabled. (Overrides Control.EnableViewState.) | |
EnsureChildControls()()() |
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from Control.) | |
EnsureID()()() |
Creates an identifier for controls that do not have an identifier assigned.
(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 |
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control.) | |
Finalize()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
FindControl(String) |
Searches the current naming container for a server control with the specified id parameter.
(Inherited from Control.) | |
FindControl(String, Int32) |
Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl()()() method.
(Inherited from Control.) | |
FinishedListener | The name of a JavaScript function (without brackets) that should be called when spell checking is finished (optional). | |
Focus()()() |
Sets input focus to a control.
(Inherited from Control.) | |
Font |
Gets the font properties associated with the Web server control.
(Inherited from WebControl.) | |
ForeColor |
Gets or sets the foreground color (typically the color of the text) of the Web server control.
(Inherited from WebControl.) | |
GetDesignModeState()()() |
Gets design-time data for a control.
(Inherited from Control.) | |
GetHashCode()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
GuiLanguage | The UI language. | |
HasAttributes |
Gets a value indicating whether the control has attributes set.
(Inherited from WebControl.) | |
HasChildViewState |
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control.) | |
HasControls()()() |
Determines if the server control contains any child controls.
(Inherited from Control.) | |
HasEvents()()() |
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from Control.) | |
Height |
Gets or sets the height of the Web server control.
(Inherited from WebControl.) | |
ID |
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from Control.) | |
IdSeparator |
Gets the character used to separate control identifiers.
(Inherited from Control.) | |
IgnoreAllMenuText | The text used for the Ignore All menu item. | |
IgnoreCapitalizedWords | Whether to ignore words with capital letters. | |
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 |
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from Control.) | |
IsChildControlStateCleared |
Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control.) | |
IsEnabled |
Gets a value indicating whether the control is enabled.
(Inherited from WebControl.) | |
IsLiteralContent()()() |
Determines if the server control holds only literal content.
(Inherited from Control.) | |
IsTrackingViewState |
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from Control.) | |
IsValid | Whether the validator has identified an error or whether spell checking has already been forced by the validator. | |
IsViewStateEnabled |
Gets a value indicating whether view state is enabled for this control.
(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 |
Occurs when the server control is loaded into the Page object.
(Inherited from Control.) | |
LoadControlState(Object) |
Restores control-state information from a previous page request that was saved by the SaveControlState()()() method.
(Inherited from Control.) | |
LoadViewState(Object) |
Restores view-state information from a previous request that was saved with the SaveViewState()()() method.
(Inherited from WebControl.) | |
LoadViewStateByID |
Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(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) |
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from Control.) | |
MemberwiseClone()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
MergeStyle(Style) |
Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
(Inherited from WebControl.) | |
NamingContainer |
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
(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) |
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from Control.) | |
OnDataBinding(EventArgs) |
Raises the DataBinding event.
(Inherited from Control.) | |
OnInit(EventArgs) |
Registers required scripts.
(Overrides Control.OnInit(EventArgs).) | |
OnLoad(EventArgs) |
Raises the Load event.
(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) |
Gets a Stream used to read a file.
(Inherited from Control.) | |
Page |
Gets a reference to the Page instance that contains the server control.
(Inherited from Control.) | |
Parent |
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from Control.) | |
PreRender |
Occurs after the Control object is loaded but prior to rendering.
(Inherited from Control.) | |
RaiseBubbleEvent(Object, EventArgs) |
Assigns any sources of the event and its information to the control's parent.
(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) |
Renders the control to the specified HTML writer.
(Inherited from WebControl.) | |
RenderBeginTag(HtmlTextWriter) |
Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl.) | |
RenderChildren(HtmlTextWriter) |
Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from Control.) | |
RenderContents(HtmlTextWriter) |
Render this control to the output parameter specified.
(Overrides WebControl.RenderContents(HtmlTextWriter).) | |
RenderControl(HtmlTextWriter) |
Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from Control.) | |
RenderControl(HtmlTextWriter, ControlAdapter) |
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
(Inherited from Control.) | |
RenderEndTag(HtmlTextWriter) |
Renders the end of this tag
(Overrides WebControl.RenderEndTag(HtmlTextWriter).) | |
RenderForDesign(HtmlTextWriter) | Renders this control for the design surface. | |
ResolveAdapter()()() |
Gets the control adapter responsible for rendering the specified control.
(Inherited from Control.) | |
ResolveClientUrl(String) |
Gets a URL that can be used by the browser.
(Inherited from Control.) | |
ResolveUrl(String) |
Converts a URL into one that is usable on the requesting client.
(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()()() |
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from Control.) | |
SaveViewState()()() |
Saves any state that was modified after the TrackViewState()()() method was invoked.
(Inherited from WebControl.) | |
SeparateHyphenWords | Whether to treat hyphenated (-) words as separate words, default is false. | |
SetDesignModeState(IDictionary) |
Sets design-time data for a control.
(Inherited from Control.) | |
SetRenderMethodDelegate(RenderMethod) |
Assigns an event handler delegate to render the server control and its content into its parent control.
(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. | |
ShowNoErrorsMessage | Whether to show the launcher button (set to false to hide button/images). The client-side code will be written regardless. | |
Site |
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control.) | |
SkinID |
Gets or sets the skin to apply to the control.
(Inherited from WebControl.) | |
SSLFriendlyPage | The URL of the file to set in Iframes, this avoids SSL warnings. | |
Style |
Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
(Inherited from WebControl.) | |
SuggestionsMethod | Suggestions method to use. Either PHONETIC_SUGGESTIONS or HASHING_SUGGESTIONS
| |
SuggestSplitWords | Whether to look for connected words in suggestions. | |
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 |
Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
(Inherited from WebControl.) | |
TagName |
Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from WebControl.) | |
TemplateControl |
Gets or sets a reference to the template that contains this control.
(Inherited from Control.) | |
TemplateSourceDirectory |
Gets the virtual directory of the Page or UserControl that contains the current server control.
(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 |
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from WebControl.) | |
ToString()()() | (Inherited from Object.) | |
TrackViewState()()() |
Causes the control to track changes to its view state so they can be stored in the object's ViewState property.
(Inherited from WebControl.) | |
UniqueID |
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from Control.) | |
Unload |
Occurs when the server control is unloaded from memory.
(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. | |
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 |
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from Control.) | |
ViewStateIgnoresCase |
Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control.) | |
Visible |
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from Control.) | |
WarnDuplicates | Whether to show duplicate words as errors (eg. "this is is an error"). | |
Width |
Gets or sets the width of the Web server control.
(Inherited from WebControl.) |
Remarks
The minimum requirements to use this control are that TextComponentID and RapidSpellWInlineHelperPage properties are set.
Eg.
CopyC#
<RapidSpellWeb:RapidSpellWInline id="rapidSpellWInline1" runat="server" TextComponentID="TextBox1" RapidSpellWInlineHelperPage="rswiHelper.aspx"> </RapidSpellWeb:RapidSpellWInline>
Inheritance Hierarchy
Object | |||
Control | |||
WebControl | |||
RapidSpellWInline |