Properties

setupPath

This property is used to set the full path to the JavaScriptSpellCheck directory within your website. It should be used as an absolute path from the root of your website.

The default value of JavaScriptSpellCheck.setupPath is /JavaScriptSpellCheck/

Example
var oSpell = new JavaScriptSpellCheck();
oSpell.setupPath="/JavaScriptSpellCheck/"

languages

The languages property is used to decide which dictionary language(s) the spell-check engine will use.

The value will be the same as the name of any dictionary you have installed in the Dictionaries directory within JavaScriptSpellCheck (do not use the ".dic" at the end though).

To choose a specific language, choose a dictionary name. E.g. "English (USA)" etc.
To choose multiple dictionaries - use a comma separated list of dictionary names. E.g. "English (Canada),Francais"

Note: These dictionaries must, of course, be installed to be used.

You may use up to 10 dictionaries simultaneously! The default value of languages is "English (International)"

Example:
var oSpell = new JavaScriptSpellCheck();
oSpell.languages="English (International)"

windowLanguage

This property is used to decide the User Interface language of the spell-checking window.

The possible values of windowLanguage are:

"EN" - For English
"ES" - For Spanish
"DE" - For German
"NL" - For Dutch
"FR" - For French
"IT" - For Italian
"PT" - For Portuguese
"NO" - For Norwegian
"SV" - For Swedish
"DK" - For Danish

The default value is "EN" for English.

Note that changing the Window Language does not automatically select the Dictionary Language used for spell-checking.

Example
var oSpell = new JavaScriptSpellCheck() ;
oSpell.windowLanguage= "FR" ;

hideSummary

This property is used to disable the spellchecker window's summary screen. Possible values are true and false.

The default value of hideSummary is false.

Example:
var oSpell = new JavaScriptSpellCheck();
oSpell.hideSummary = false

externalCSS

This property is to attach an optional CSS style sheet to the spell checking window . If this property is not set, the default CSS will resemble MS-Word's Spell Checker using Windows XP.

There is a sample style sheet included in the Assets folder within JavascriptSpellCheck . To use this effectively, it is advisable to study the output HTML from the window.

Example:
var oSpell = new JavaScriptSpellCheck();
oSpell.externalCSS = "assets/sample.css";

caseSensitive

This Boolean property is used to decide if the spell-checker will act in a case sensitive manner. The default value is defined true.

Note: Also see the checkGrammar property. If checkGrammar is set to true then the spellchecker can pickup irregularities in sentence casing even if caseSensitive is set to false.

Example:
var oSpell = new JavaScriptSpellCheck();
oSpell.caseSensitive= false;

checkGrammar

This Boolean property is used to decide if the spell-check engine will find basic grammar mistakes such as repeated words, poor sentence casing etc.

The default value is true.

Example
If you want your spellchecker to ignore grammatical mistakes :

var oSpell = new JavaScriptSpellCheck();
oSpell.checkGrammar = false;

ignoreAllCaps

This Boolean property is used to decide if the spell-check engine will ignore words which are in ALL CAPITALS, such as acronyms.

The default value is true.

Example
var oSpell = new JavaScriptSpellCheck();
oSpell.ignoreAllCaps = true

ignoreWebAddresses

This Boolean property is used to decide if the spell check engine will ignore words which resemble:

• web addresses (such as http://www.JavaScriptSpellCheck.com or "Ebay.com ")
• email addresses (such as " info@javascriptspellcheck.com " ).

The default value is true.

Example:
var oSpell = new JavaScriptSpellCheck();
oSpell.ignoreWebAddresses = true

ignoreNumbers

This Boolean property is used to decide if the spell-check engine will ignore words containing numbers such as "$100million" or "8Ball".

The default value is true.

Example:
var oSpell = new JavaScriptSpellCheck();
oSpell. ignoreNumbers = true

newSentenceOnEachNewLine

This Boolean property is used to decide if the spell-check engine will expect a new sentence after each carriage return (new line). This is useful to ensure proper grammar as per a word-processor, but may not be appropriate for more 'casual' web forms.

The default value is false.

Example
var oSpell = new JavaScriptSpellCheck();
oSpell.newSentenceOnEachNewLine = true

useServerSession

This Boolean property is used to decide if the spell-check engine will use the IIS Session object to accelerate the dialog for each user. Using the session will reduce the bandwidth used by the spellcheck window, but will use more server memory.

The default value is true.

Example:
var oSpell = new JavaScriptSpellCheck();
//If you don't want your spellchecker to use the session
oSpell.useServerSession = false

ajaxEnabled (read only)

The ajaxEnabled property allows you to determine if the client browser can use Ajax . Ajax is needed for the spellCheck, ajaxSpellCheck and spellCheckWindowTest methods.

The results is Boolean - either true or false.

»