Dialog Spell Checking

All text boxes (within a form on the page) will be spell checked, unless specifically indicated to be ignored

1. Add the RapidSpell client files to the project (per 'Installation').
2. Drag RapidSpell-DIALOG.js from Solution Explorer into the page, this will add a <script src="RapidSpell-DIALOG.js"></script> tag to the page with the correct path.
3. All textboxes (that are inside a FORM element, and have their id attribute set) will be checked when the user triggers the spell check eg. in a button click handler;

   <input type="button" onclick="rapidSpell.dialog_spellCheck()" value="Spell Check" />
   //or for a specific text box
   <input type="button" onclick="rapidSpell.dialog_spellCheck(true, 'textBoxID1')" value="Spell Check" />
   //or for a list of specific text boxes
   <input type="button" onclick="rapidSpell.dialog_spellCheck(true, ['textBoxID1', 'textBoxID2', ...])" value="Spell Check" />
   

Disabling spell check on specific text boxes

• Add the attribute nospell="true" to the text box.
• Or, add the (client) ID of text box to the Javascript array rapidSpell.ayt_ignoreTextBoxIds,
  eg. either 1 of
  

  rapidSpell.dialog_ignoreTextBoxIds[rapidSpell.dialog_ignoreTextBoxIds.length] = 'textBox1'; //where textBox1 is the id attribute of a textbox
  rapidSpell.dialog_ignoreTextBoxIds[rapidSpell.dialog_ignoreTextBoxIds.length] = '<%= textBox1.ClientID %>'; //where textBox1 is an asp:textbox tag.
  

Modifying or removing the 'Add' option

Please see the user dictionary topic.

Setting field display labels

The dialog can show a label for which text field it is currently spell checking. To enable this, set the field display text (this must be done after the textboxes have been added to the DOM), eg.

	var oldload = onload;
	onload = function () {
		if (typeof oldload == 'function') oldload();
		rapidSpell.setParameterValue(document.getElementById('TextBox1'), 'FieldDisplayText', 'Text box 1');
		rapidSpell.setParameterValue(document.getElementById('TextBox2'), 'FieldDisplayText', 'Text box 2');
		rapidSpell.setParameterValue(document.getElementById('TextBox3'), 'FieldDisplayText', 'Text box 3');
	}

This code uses an override of window.onload, and because of that requires that we call any existing 'onload' functions. jQuery 'ready' handlers would not require this.

MVC usage

Please see the MVC Usage page.

Using jQuery UI Dialog instead of a popup

In the Javascript for your page, call

rapidSpell.dialog_setUseDivDialog(true); //use false to deactivate

<link rel="stylesheet" href="/.../jquery-ui.css" />
<script src="/.../jquery-1.11.3.min.js"></script>
<script src="/.../jquery-ui.min.js"></script>

The jQuery UI Dialog mode uses an AJAX call to either WCF or ASMX based Web Service. The WCF service is used by default but this will only work with .NET 4 (project must reference Keyoti.RapidSpellWeb.ASP.NETv4.DLL). For Keyoti.RapidSpellWeb.ASP.NETv2.DLL, use the ASMX service by calling (in Javascript):

rapidSpell.setServiceType('asmx');

Modal mode

To display the spell check dialog modally, call

rapidSpell.dialog_setUseDivDialog(true); 
rapidSpell.dialog_modal = true;

User options

There are several options available to the user via the "Options..." button in the dialog. Any changes to these options will override any settings specified in code. To disable the user options button (and any settings specified by the user), call

rapidSpell.setParameterValue('default', 'EnableOptions', false);

User options are stored in browser cookies and are not transferable to other devices as-is. Options apply to 'as you type' spell checking as well.

jQuery Dialog Troubleshooting

If you get '500' server errors, please check:

• If the project uses Keyoti.RapidSpellWeb.ASP.NETv2.DLL, then the page scripts must call rapidSpell.setServiceType('asmx'), in order to use the .NET 2 compatible Web Service.
• That the memory usage on the machine is not up near 100%. It has been found that the web services shut down when overall system memory consumption is high (this is a 'feature' of IIS/IISExpress).
• Use the F12 tool's Network tab, to record traffic to the Web Services. Inspect the response from the server for more detail about what is going wrong.

We don't want you to struggle, so please email support@keyoti.com if problems persist.