IHyphenationCallback Interface

Implemented by classes which can register hyphenation dictionaries.

Namespace:  Aspose.Words
Assembly:  Aspose.Words (in Aspose.Words.dll) Version: 20.2
public interface IHyphenationCallback

The IHyphenationCallback type exposes the following members.

Public methodCode exampleRequestDictionary
Notifies application that hyphenation dictionary for the specified language wasn't found and may need to be registered.

Implementation should find a dictionary and register it using RegisterDictionary(String, Stream) methods.

If dictionary is unavailable for the specified language implementation can opt out of further calls for the same language using RegisterDictionary(String, String) with null value.

Shows how to open and register a dictionary from a file.
public void RegisterDictionary()
    // Set up a callback that tracks warnings that occur during hyphenation dictionary registration
    WarningInfoCollection warningInfoCollection = new WarningInfoCollection();
    Hyphenation.WarningCallback = warningInfoCollection;

    // Register an English (US) hyphenation dictionary by stream
    Stream dictionaryStream = new FileStream(MyDir + "hyph_en_US.dic", FileMode.Open);
    Hyphenation.RegisterDictionary("en-US", dictionaryStream);

    // No warnings detected
    Assert.AreEqual(0, warningInfoCollection.Count);

    // Open a document with a German locale that might not get automatically hyphenated by Microsoft Word an english machine
    Document doc = new Document(MyDir + "Unhyphenated German text.docx");

    // To hyphenate that document upon saving, we need a hyphenation dictionary for the "de-CH" language code
    // This callback will handle the automatic request for that dictionary 
    Hyphenation.Callback = new CustomHyphenationDictionaryRegister();

    // When we save the document, it will be hyphenated according to rules defined by the dictionary known by our callback
    doc.Save(ArtifactsDir + "Hyphenation.RegisterDictionary.pdf");

    // This dictionary contains two identical patterns, which will trigger a warning
    Assert.AreEqual(1, warningInfoCollection.Count);
    Assert.AreEqual(WarningType.MinorFormattingLoss, warningInfoCollection[0].WarningType);
    Assert.AreEqual(WarningSource.Layout, warningInfoCollection[0].Source);
    Assert.AreEqual("Hyphenation dictionary contains duplicate patterns. The only first found pattern will be used. " +
                    "Content can be wrapped differently.", warningInfoCollection[0].Description);

/// <summary>
/// Associates ISO language codes with custom local system dictionary files for their respective languages
/// </summary>
private class CustomHyphenationDictionaryRegister : IHyphenationCallback
    public CustomHyphenationDictionaryRegister()
        mHyphenationDictionaryFiles = new Dictionary<string, string>
            { "en-US", MyDir + "hyph_en_US.dic" },
            { "de-CH", MyDir + "hyph_de_CH.dic" }

    public void RequestDictionary(string language)
        Console.Write("Hyphenation dictionary requested: " + language);

        if (Hyphenation.IsDictionaryRegistered(language))
            Console.WriteLine(", is already registered.");

        if (mHyphenationDictionaryFiles.ContainsKey(language))
            Hyphenation.RegisterDictionary(language, mHyphenationDictionaryFiles[language]);
            Console.WriteLine(", successfully registered.");

        Console.WriteLine(", no respective dictionary file known by this Callback.");

    private readonly Dictionary<string, string> mHyphenationDictionaryFiles;
See Also