RadControls for WinForms

RadSpellChecker comes with one predefined dictionary which checks the English language. In case you need a dictionary for another language, you check the Dictinaries for RadSpellChecker article where our customers have provided their own implementation of dictionaries for the different languages. The following section demonstrates how you can load one of these dictionaries in your own project.

Loading a custom dictionary

Note

To access the RadSpellChecker related types, you need to include the Telerik.WinControls.RichTextBox.Proofing namespace

  1. Let's say that you have chosen one of the dictionary files provided in this article, for example, the German (Germany) (de-DE) dictionary.

  2. Now let's load the dictionary file (*.TDF) in our project as a project resource.

  3. Further, we should create a WordDictionary descendant. Let's call the descendant GermanDictionary. In this class we should override the EnsureDictionaryLoadedOverride method, create a MemoryStream based on the TDF resource and call the Load method of the WordDictionary class passing the MemoryStream as a parameter. Assuming that our CSharp project is called SamplesCS the code looks as shown below:

    Copy[C#]
    public class GermanDictionary : WordDictionary
    {
        protected override void EnsureDictionaryLoadedOverride()
        {
            using (MemoryStream ms = new MemoryStream(SamplesCS.Properties.Resources.de_DE))
            {
                this.Load(ms);
            }
        }
    }
    Copy[VB.NET]
    Public Class GermanDictionary
        Inherits WordDictionary
        Protected Overrides Sub EnsureDictionaryLoadedOverride()
            Using ms As MemoryStream = New MemoryStream(My.Resources.de_DE)
                Me.Load(ms)
            End Using
        End Sub
    End Class

  4. Next, we should add the custom dictionary to our RadSpellChecker. Please note, that dictionaries are added per control types basis using the GetControlSpellChecker method. This way, using just one RadSpellChecker instance you can add different dictionaries of one and the same language in the context of different controls that need to be spell checked. For example, here we are going to add a Dictionary that will be used only for RadTextBox instances. In addition, we need to define a CultureInfo that will be stored together with the dictionary in the list of dictionaries. This culture will serve as a primary key for the respective dictionary in the dictionaries collection.

    Copy[C#] Defining a culture
    private static readonly CultureInfo GermanCulture = CultureInfo.GetCultureInfo("de-DE");
    Copy[VB.NET] Defining a culture
    Friend Shared GermanCulture As CultureInfo = CultureInfo.GetCultureInfo("de-DE")
    Copy[C#] Adding a dictionary
    IControlSpellChecker textBoxControlSpellChecker = this.radSpellChecker1.GetControlSpellChecker(typeof(RadTextBox));
    DocumentSpellChecker documentSpellChecker = textBoxControlSpellChecker.SpellChecker as DocumentSpellChecker;
    documentSpellChecker.AddDictionary(new GermanDictionary(), GermanCulture);
    Copy[VB.NET] Adding a dictionary
    Dim textBoxControlSpellChecker As IControlSpellChecker = Me.radSpellChecker1.GetControlSpellChecker(GetType(RadTextBox))
    Dim documentSpellChecker As DocumentSpellChecker = TryCast(textBoxControlSpellChecker.SpellChecker, DocumentSpellChecker)
    documentSpellChecker.AddDictionary(New GermanDictionary(), GermanCulture)

  5. Now, we have to set the SpellCheckingCulture property that will determine which of the available dictionaries will be used (in case dictionaries of different languages are added).

    Copy[C#] Setting the culture
    documentSpellChecker.SpellCheckingCulture = GermanCulture;
    Copy[VB.NET] Setting the culture
    documentSpellChecker.SpellCheckingCulture = GermanCulture
    If this property is not set, RadSpellChecker will try check if there is a dictionary whose culture is the CurrentUICulture of the application. If such a dictionary is found, RadSpellChecker will use that dictionary.