Document.Hyphenation Property

Gets or sets whether to enable hyphenation in a document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

bool Hyphenation { get; set; }

VB.NET

Property Hyphenation As Boolean

Property Value

Type	Description
Boolean	true, to enable hyphenation; otherwise, false.

Remarks

Set the Hyphenation property to true to hyphenate all text in the document. Use the Document.HyphenateCaps property to determine whether to hyphenate words in CAPS.

Provide the hyphenation dictionary to automatically hyphenate words in a document. Otherwise, the Hyphenation property has no effect.

The following properties provide access to the component’s collection of hyphenation dictionaries:

• RichEditDocumentServer.HyphenationDictionaries (Office File API)
• RichEditControl.HyphenationDictionaries (WinForms)
• RichEditControl.HyphenationDictionaries (WPF)

Use an OpenOfficeHyphenationDictionary class object to add an OpenOffice hyphenation dictionary to the component. The CustomHyphenationDictionary class represents hyphenation pattern files containing words divided into syllables, (e.g., hy-phen-ation).

The code sample below shows how to add an OpenOffice dictionary to the component and enable hyphenation:

C#

OpenOfficeHyphenationDictionary hyphenationDictionary = new OpenOfficeHyphenationDictionary("hyph_sl_SI.dic", new System.Globalization.CultureInfo("sl-SL"));
server.HyphenationDictionaries.Add(hyphenationDictionary);

server.Document.Hyphenation = true;

VB.NET

Dim hyphenationDictionary As OpenOfficeHyphenationDictionary = New OpenOfficeHyphenationDictionary("hyph_sl_SI.dic", New System.Globalization.CultureInfo("sl-SL"))
server.HyphenationDictionaries.Add(hyphenationDictionary)

server.Document.Hyphenation = True

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Hyphenation property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

word-document-api-enable-automatic-hyphenation/CS/word-processing-hyphenation/Program.cs#L35

//Specify hyphenation settings
wordProcessor.Document.Hyphenation = true;
wordProcessor.Document.HyphenateCaps = true;

winforms-richedit-link-hyphenation-dictionaries/CS/XtraRichEdit/Form1.cs#L51

    //Enable automatic hyphenation
    document.Hyphenation = true;
}

VB.NET

word-document-api-enable-automatic-hyphenation/VB/word-processing-hyphenation/Program.vb#L31

'Specify hyphenation settings
wordProcessor.Document.Hyphenation = True
wordProcessor.Document.HyphenateCaps = True

winforms-richedit-link-hyphenation-dictionaries/VB/XtraRichEdit/Form1.vb#L49

    'Enable automatic hyphenation
    document.Hyphenation = True
End Sub