Object Reference

 Dictionary

The dictionary language which the spell checker will use.  The default is  English (International) . 

To change the Dictionary value, you must first download a new dictionary (.dic) file from www.aspnetspell.com, and copy it into the ~/AspNetSpell/dictionaries directory.  The value should match the file name (excluding the .dic extension).

To use multiple dictionaries you can use a comma-separated list. E.g. :   English (Canada), Francais 

You can also encode you or dictionaries using the AspNetSpell dictionary encoder (download from www.aspnetspell.com)

In addition, you can add words to the list by putting them in the file AspNetSpell/Dictionaries/custom.txt .  Put 1 word per line, preferably in alphabetical order.

 FieldsToSpellCheck

The ID of the field(s) which the component will spell check when the AspNetSpell button is pressed. 

This is normally a TextBox or Rich Editor such as FCK Editor or ActiveUp Editor.

To spell check multiple fields with 1 button, use a comma separated list.  E.g. :   textBox1,textBox2 

The default value is "ALL" which will spell check all text fields on the page.

Advanced Usage

Advanced users can target fields for spellchecking using JavaScript object references in this form:
js:document.getElementById('textBox1'), js:document.getElementById('textBox2') ...

There is also shorthand API for targeting iFrames in this form:
iframe:myIframeid, ifame:parentFrameId.childFrameId.secondChildFrameId

 InstallPath

The path where you copied (installed) the AspNetSpell in your website.  It is simplest normally to keep this as  ~/AspNetSpell .

If the InstallPath does is not correctly set, you will be given a visual warning in Visual Studio.

 LicenseKey

If you have purchased a license for AspNetSpell, copy it into this property.  This will unlock the software for commercial use.

Your key may also be used by copying it into ~/ASPNetSpell/RegKey.asp

 CapitalizeNewLines

This boolean value defines if the spellchecker will expect new lines of text to start with proper capitalization.

 CaseSensitive

This boolean value defines if the spellchecker is case sensitive.

 CheckGrammar

This boolean value defines if the spellchecker will perform grammar checking. Note that this grammar check is not as sophisticated as that of MS Word - but it does pick up basic structural mistakes.

 IgnoreAllCaps

This boolean value defines if the spellchecker will ignore words in ALL CAPITALS, which are usually acronyms. 

 IgnoreNumbers

This boolean value defines if the spellchecker ignores words with numbers in them such as  M15  or  TBC211 ,  these normally are technical words or product codes.

 IgnoreWebAddresses

This boolean value defines if the spellchecker will accept urls and email addresses.

 DialogLanguage

The User Interface language for the spellchecker Dialog.  Possible Values 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

 ExternalCSS

The URL of an alternate CSS file used to skin the SpellChecker Dialog. An example file can be found in AspNetSpell/Assets.

Use of this requires a study of the HTML generated by the spellchecker dialog.

 HideSummaryScreen

Hides the summary screen if set to true.  This is useful if the spellchecker is going to submit a form.  Please also see the OnSpellCheckComplete event.

 UseSessionForAcceleration

If set true, The spellchecker will use the IIS session object to reduce the applications bandwidth usage, and increase speed for the client.

 OnSpellCheckComplete

This server event is fired directly after spell-checking.