This guide covers basic installation in an ASP.Net Web Application:


1.Downloading the Software

ASPNetSpell can be downloaded from www.aspnetspell.com as a zip file.

File:Zipfile.gif

When you have downloaded the package, unzip it to a convenient location on your hard disk for future use.


There are 2 main sets of files that you have downloaded:

  • AspNetSpell.dll - Add this to your Visual Studio toolbox. (see below)
  • A directory of files labelled ASPNetSpellInclude - Copy and paste this to the root folder of your website project (see below). You do not need to add this to the application in Visual Studio.

2. Adding AspNetSpell.dll to the Visual Studio ToolBox

Using the Automatic Installer

Visual Studio 2005 / 2008 / 2010
  1. Unzip ASPNetSpell
  2. Close Visual Studio
  3. Double Click on ASPNetSpell/Install.vscontent
  4. When you re-open your website in Visual Studio you will now see SpellButton and SpellTextBox the the "My Controls" section of the toolbox.

File:Installer.png

Manually installing the DLL

Alternative Installation Method for Visual Studio 2000, 2003, 2005 / 2008 / 2010 / 2012

Right click on the Visual Studio ToolBox and pick "Choose Items...". In the new dialog, click "Browse...", then pick the AspNetSpell.dll which you downloaded and click "OK". You now have drag-and-drop access to AspNetSpell for web application development.

File:Toolbox.gif

ASP.Net Runtime Versions

ASPNetSpell.dll comes in 3 different versions for dfferent ASP.net runtime. Make sure to download the right one.

3. Installing the AspNetSpellInclude Directory to your Web Project

After dragging the AspNetSpell component onto a web form, you must copy the downloaded directory AspNetSpellInclude into the root folder of your website. If this location is inconvenient, you can specify another URL for the files using the InstallationPath property.

The best way to do this is to drag-and-drop the folder into your Solution Explorer from Windows.

File:IncludeFolder.png

4. Getting to Hello World

Once you have installed the ASPNetSpellInclude directory properly, you are ready to start spell checking. Just Drag the SpellButton into your webs form.

To select the field(s) that ASPNetSpell will spell check, change the FieldsToSpellCheck property. By default it will spell check every viable field on the page.

If you see a red cross on the screen or are given warning messages - read the (Troubleshooting) guide.

270px

5. As You-Type-Spell Checking

Drag the SpellTextBox into the web form in place of any normal multi-line TextBox. As you type spell checking is automatically provided.

File:SpellTextAreaFF.png 

6. Installing Dictionaries

The dictionary language which the spellchecker will use is set by the DictionaryLangauge property.

To install dictionaries - you must first download them from www.aspnetspell.com/Downloads.

The value of the Dictionary property should match the file name (excluding the .dic extension). Dictionaries include:

Specialist Dictionaries

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 dictionary encoder.

In addition, you can add words to the list by putting them in the file ASPNetSpellInclude/Dictionaries/custom.txt . Put 1 word per line, preferably in alphabetical order for performance issues. This sorting can be achieved using software like MS Excel or EditPlus.

To change the language of spellchecker dialogs and buttons please see UserInterfaceLanguage property.