Javascript Events and API for ASPNetSpell

• 1. Simple .Net Event Model - OnSpellCheckComplete
• 2. JavaScript Event Model
• 3. Full JavasScpit Object Reference
  • 3.1. Class LiveSpellObject
• 4. The AJAX API
• 5. Installation outside of ASP.Net Applications

ASPNetSpell has a full JavaScript API allowing the advanced developer to capture events and modify behaviour of spell-checkers at client runtime.

This demo shows the Javscript API capturing the onDialogOpen and onChangeWord (as-you-type) events.

ASPNetSpell has a full JavaScript API allowing the advanced developer to capture events and modify behaviour of spell-checkers at client runtime.

Simple .Net Event Model - OnSpellCheckComplete

If you just want to submit a form upon spell-check dialog completion - see the ASP.Net SpellButton Event - OnSpellCheckComplete

JavaScript Event Model

Each SpellButton and SpellTextArea at the server side are paired with a clientside instance of LiveSpellOject - a Javascript class documented below.

• You can acess this API using the JavaScript identifier JavaScriptId for each object
  • E.g.<%= SpellButton1.JavaScriptId%>
• This code must be placed AFTER the last <form> tag on the page
• The script tag should have the 'defer' attribute set for IE compatibility.

<form id="form1" runat="server">
           <ASPNetSpell:SpellTextBox ID="SpellTextBox1" runat="server">
            ...
            </ASPNetSpell:SpellTextBox>

           <ASPNetSpell:SpellButton ID="SpellButton1" runat="server" />
</form>

<script type='text/javascript' defer='defer' > 
// This script must come after the end of the < /form > tag 	 
// Notice the defer='defer' attribute for IE compatibility

 	var mySpellButton= <%=SpellButton1.JavaScriptId%>;
	mySpellButton.onDialogOpen = function(){ alert("onDialogOpen Dialog Event fired by SpellButton1")}

	var mySpellTextBox= <%=SpellTextBox1.JavaScriptId%>;
	mySpellTextBox.onChangeWord = function(){ alert("onChangeWord As-You-Type Event fired by SpellTextBox1")}
</script>

Events can apply to both as-you-type and in dialog spellchecking as needed:

• onDialogOpen
• onDialogComplete
• onDialogCancel
• onDialogClose
• onChangeLanguage
• onIgnore
• onIgnoreAll
• onChangeWord
• onChangeAll
• onLearnWord
• onLearnAutoCorrect
• onUpdateFields

Full JavasScpit Object Reference

Class LiveSpellObject

Defined in /ASPNetSpellInclude/include.js

<script src="/ASPNetSpellInclude/include.js' type='text/javascript'></script>
<script type='text/javascript'>
// E.g. 
var mySpell = new LiveSpellInstance();
mySpell.Fields = "ALL"
mySpell.ServerModel="aspx"
mySpell.DrawSpellImageButton()
mySpell.ActivateAsYouType()
</script>

The AJAX API

The Ajax API allows your to make Asynchronous server requests for spellcheciing from the client page without refreshing the browser.

Installation outside of ASP.Net Applications

The JavaScript API allows developers the choice to use all of ASPNetSpell's functionality using JavaScript as the integration language... anywhere on an IIS server that supports ASP.net.

1. Ensure that /ASPNetSpellInclude/ is installed in the website root (and test this installation using the examples in /ASPNetSpellInclude/debug-test-scripts/).
2. Use JavaScript to implement ASPNetSpell.

e.g.

<script src="/ASPNetSpellInclude/include.js' type='text/javascript'></script>
<script type='text/javascript'>
var mySpell = new LiveSpellInstance();
mySpell.Fields = "ALL"
mySpell.ServerModel="aspx"
mySpell.DrawSpellImageButton()
mySpell.ActivateAsYouType()
</script>