ieSpell - ieSpell API for Web Application Developers

Scripting ieSpell

ieSpell exposes an automation interface and hence can be scripted directly as an ActiveX control from within a web page. You can find more information regarding this interface below.

In addition, we have provided some useful JavaScript functions that you can take advantage of. As well as a sample HTML showcasing how ieSpell can be scripted. You can find both these files in this zip file.

Including Script Support

To include scripting support, simply add the following statement within the HEAD of your HTML:

where "./scripts/ieSpell.js" is the path to the location of the ieSpell JavaScript on your server.

Invoking ieSpell

The easiest way to invoke ieSpell is by including the following code snippet at the location where you want the spell check button:

This JavaScript function will take care of invoking ieSpell when clicked if ieSpell is already installed. Otherwise it will open a new window to allow the user to download and install ieSpell.

Getting ieSpell to Ignore Specific Input Fields

ieSpell allows a web page to control which input fields are to be spell checked. To achieve this, use the custom attribute ieSpell_ignored. The following is an example of where this custom attribute can be included.

ieSpell's Automation Interface

For the technically inclined, ieSpell exposes 4 different functions for invoking the spell check:

void CheckDocumentNode(node)

This function will cause ieSpell to check only the input field that is specified.

void CheckAllLinkedDocuments()

This function will cause ieSpell to check all input fields in the document.

bool CheckDocumentNode2(node)

This function is an extended version of CheckDocumentNode(). Beside invoking ieSpell only on the input field specified, it will cause ieSpell not to prompt the message "The spelling check is complete." upon normal completion of the spell checking session as well as returning false if the user cancels the spell check.

bool CheckAllLinkedDocuments2()

This function is an extended version of CheckAllLinkedDocuments(). Beside invoking ieSpell to check all the input fields within the document, it will cause ieSpell not to prompt the message "The spelling check is complete." upon normal completion of the spell checking session as well as returning false if the user cancels the spell check.