[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Collapse]Controls and Libraries
  [Expand]Forms and User Controls
  [Expand]Messages, Notifications and Dialogs
  [Expand]Editors and Simple Controls
  [Expand]Ribbon, Bars and Menu
  [Expand]Application UI Manager
  [Expand]Docking Library
  [Expand]Data Grid
  [Expand]Vertical Grid
  [Expand]Property Grid
  [Expand]Pivot Grid
  [Expand]Tree List
  [Expand]Chart Control
  [Expand]Diagrams
  [Expand]Gauges
  [Expand]Map Control
  [Expand]Scheduler
  [Expand]Spreadsheet
  [Collapse]Rich Text Editor
   [Expand]Product Information
    Product Class Structure
    Supported Formats
   [Expand]Getting Started
   [Expand]RichEditControl Document
   [Expand]Fields
    Text Formatting
    Import and Export
   [Expand]Page Layout
    Printing
    Spell Checking
    AutoCorrect
    Mail Merge
    Restrictions and Protection
    Syntax Highlighting
    Traversing the Document
   [Expand]Visual Elements
    Services
    Events
    Commands
    Keyboard Shortcuts
    HTML Tag Support
   [Expand]Examples
  [Expand]Spell Checker
  [Expand]Form Layout Managers
  [Expand]Navigation Controls
  [Expand]Printing-Exporting
  [Expand]PDF Viewer
   Reporting
  [Expand]Snap
  [Expand]TreeMap Control
 [Expand]Common Features
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Spell Checking

The RichEditControl uses the Spell Checker component to implement the spell checking functionality.
Perform the following steps to add a spell checker to your application:

  1. The SpellChecker is added automatically when the RichEditControl application is created using the Template Gallery. To add the SpellChecker to the application manually, drag the SpellChecker component icon from Visual Studio's toolbox onto the form that contains the RichEditControl. The RichEditControl.SpellChecker property is set once the component is placed onto the form.

    Note

    When the RichEditControl is used as a repository editor in XtraGrid, spelling suggestions could be missing from the context menu if the RichEditorControl is not on the same form as the SpellChecker. To avoid this, force menu creation by calling the SpellChecker.SetShowSpellCheckMenu method within the ColumnView.ShownEditor event.

  2. Add one of the following supported dictionaries:

    The SpellChecker uses the default English dictionary if no dictionary is specified. The default dictionary is not loaded when any other dictionary, including a custom dictionary, is added. Refer to the Dictionaries topic for details.

    The SpellChecker automatically detects current text's culture (returned by the CharacterPropertiesBase.Language property) and selects the corresponding dictionary. If the document should only use one dictionary if it contains text with different cultures, set the dictionary's Culture property to Invariant or set the SpellCheckerOptions.AutoDetectDocumentCulture property to false.

  3. Fine-tune the spell checker. Use one of the following properties to specify the spell checker's options:

    API Description
    SpellChecker.OptionsSpelling Provides access to the OptionsSpelling instance that contains options that affect text processing.
    RichEditControlOptionsBase.SpellChecker Obtains a SpellCheckerOptions object containing options that specify how the spell checker should process text in any document range.
    SpellChecker.SpellCheckMode Gets or sets the XtraSpellChecker's operation mode.
    SpellCheckerBase.SpellingFormType Gets or sets the type of form that is shown when a possible misspelled word is found.
    Note

    The options the SpellChecker.CheckAsYouTypeOptions property specifies does not affect the RichEditControl.

As a result, end-users can use the Spelling item on the Review ribbon tab to check the document's spelling. It invokes the Spelling Dialog allowing you to select the misspelled word's replacement, skip it or add it to the dictionary.

Enabling the SpellCheckMode.AsYouType mode underlines misspelled words. End-users can right-click these words and replace them with a suggestion from the context menu or invoke the Spelling Dialog by clicking the Spelling item.

Note

The SpellChecker does not support underlining misspelled words in multiple controls at the same time. Words are underlined in the currently focused control only. Use the SpellChecker.CheckContainer method to check spelling in multiple controls at once on demand.

Expanded See Also

Is this topic helpful?​​​​​​​