Checking Spelling in Different Controls

• Dec 17, 2020
• 2 minutes to read

The ASPxSpellChecker component provides you with the capability to check the text in a wide range of text-aware controls. To get the list of controls supported by ASPxSpellChecker, see Supported Controls. This document describes methods for enabling spell check in your application. To learn about spell checking algorithms, and what should be done prior to starting spell check, refer to Spell Check Algorithms.

Enable Spell Checking in a Control

To specify the control to be processed by ASPxSpellChecker, perform the following steps:

1. Set the ASPxSpellChecker.CheckedElementID property value of the ASPxSpellChecker control to the ID of the control to be checked.

2. To provide a correct ID for the spell checker’s client script, handle the ASPxSpellChecker.CheckedElementResolve event of the ASPxSpellChecker:

   C#

   protected void ASPxSpellChecker1_CheckedElementResolve(object sender, 
   DevExpress.Web.ControlResolveEventArgs e) {
       e.ResolvedControl = TextBox1;
   }
   

   VB.NET

   Protected Sub ASPxSpellChecker1_CheckedElementResolve(ByVal sender As Object,  _
           ByVal e As DevExpress.Web.ControlResolveEventArgs)
       e.ResolvedControl = TextBox1
   End Sub
   

3. Call the ASPxClientSpellChecker.Check method in, for instance, the button’s client-side Click event handler:

   JS

   function(s, e) {
       spellChecker.Check();
   }
   

Enable Spell Checking in a Control Container

The ASPxSpellChecker component provides you with the capability to check the text of the controls placed onto the control container. You can do this by calling the ASPxClientSpellChecker.CheckElementsInContainer method in, for instance, the button’s client-side Click event handler:

JS

function(s, e) {
    spellChecker.CheckElementsInContainer(roundPanel.GetMainElement());
}

This code uses the ASPxClientControlBase.GetMainElement function, enabling access to the topmost object in the control’s object model. This object will be treated by a spell checker as the container that encompasses elements with text contents being checked.