# HyphenationList Class

> The HyphenationList class represents a list of hyphenation rules that gets its content from a Hunspell Open Source hyphenation dictionary. As with all objects of type HyphenationList the content of that list is only accessed when the dictionary is added to the TXSpell.HyphenationLists collection. The first implementation loads a Hunspell Open Source hyphenation dictionary from a file that is defined by a dictionary path. Using the dictionary name only without a file path, the corresponding dictionary file of the default hyphenation list folder is used. The second constructor loads a hyphenation dictionary from string arrays that represent the content of a Hunspell Open Source hyphenation dictionary. It is recommended to create these arrays by using the encoding that is defined in the corresponding file represented by the encoding string in the first line. Using this implementation, it is also required to define the language of the dictionary by setting the System.Globalization.CultureInfo language parameter that sets the Proofing.HyphenationList.Language property automatically.

- **Product:** TX Spell .NET for Windows Forms
- **Section:** Reference
- **Kind:** Class
- **Introduced:** 4.0
- **Namespace:** `TXTextControl.Proofing`
- **Package:** `TXTextControl.TXSpell.WinForms.SDK` (assembly `TXSpell.dll`, from the private NuGet feed or Text Control Offline Packages)
- **Package:** `TXTextControl.TXSpell.Core.SDK` (assembly `TXSpell.dll`, from the private NuGet feed or Text Control Offline Packages)
- **.NET Framework:** reference `TXSpell.dll` from the setup
- **Path:** TX Spell .NET for Windows Forms > Reference > TXTextControl.Proofing > HyphenationList Class
- **1193 words**
- **Web URL:** https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/
- **LLMs URL:** https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/llms-full.txt

---

### Description

The HyphenationList class represents a list of hyphenation rules that gets its content from a Hunspell Open Source hyphenation dictionary. As with all objects of type HyphenationList the content of that list is only accessed when the dictionary is added to the [TXSpell.HyphenationLists collection](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/txspell/hyphenationlists-property/llms-full.txt). The first implementation loads a Hunspell Open Source hyphenation dictionary from a file that is defined by a dictionary path. Using the dictionary name only without a file path, the corresponding dictionary file of the default hyphenation list folder is used. The second constructor loads a hyphenation dictionary from string arrays that represent the content of a Hunspell Open Source hyphenation dictionary. It is recommended to create these arrays by using the encoding that is defined in the corresponding file represented by the encoding string in the first line. Using this implementation, it is also required to define the language of the dictionary by setting the `System.Globalization.CultureInfo` language parameter that sets the [Proofing.HyphenationList.Language](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/language-property/llms-full.txt) property automatically.

### Syntax

```csharp
public sealed class HyphenationList
```

```vbnet
Public NotInheritable Class HyphenationList
```

### Examples

The following example creates a Hyphenation List instance and configures its min syllables after compound hyphenation point setting for a document workflow.

```csharp
TXTextControl.Proofing.HyphenationList hyphenationList = new("document.docx");
hyphenationList.MinSyllablesAfterCompoundHyphenationPoint = 10;
```

```vbnet
Dim hyphenationList As New TXTextControl.Proofing.HyphenationList("document.docx")
hyphenationList.MinSyllablesAfterCompoundHyphenationPoint = 10
```

---

## In This Section

- [HyphenationList Constructor](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/constructor/llms-full.txt): Initializes a new instance of the HyphenationList class.
- [HyphenationList.HyphenateCapitalizedWords Property](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/hyphenatecapitalizedwords-property/llms-full.txt): Gets or sets a value indicating whether words in uppercase will be hyphenated. The default value is true.
- [HyphenationList.IsSelectedAsDefault Property](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/isselectedasdefault-property/llms-full.txt): Gets a value indicating whether the hyphenation list is selected as the default hyphenation list by the HyphenationLanguage property. The default value is false.
- [HyphenationList.Language Property](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/language-property/llms-full.txt): Gets or sets the hyphenation list's language.
- [HyphenationList.MinCharsAtWordBegin Property](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/mincharsatwordbegin-property/llms-full.txt): Specifies the minimum number of joined characters at the beginning of a hyphenated word. The default value is 2.
- [HyphenationList.MinCharsAtWordEnd Property](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/mincharsatwordend-property/llms-full.txt): Specifies the minimum number of joined characters at the end of a hyphenated word. The default value is 2.
- [HyphenationList.MinSyllablesAfterCompoundHyphenationPoint Property](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/minsyllablesaftercompoundhyphenationpoint-property/llms-full.txt): Specifies the minimum number of syllables behind a compound hyphenation point. The default value is 1.
- [HyphenationList.MinSyllablesBeforeCompoundHyphenationPoint Property](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/minsyllablesbeforecompoundhyphenationpoint-property/llms-full.txt): Specifies the minimum number of syllables before a compound hyphenation point. The default value is 1.
- [HyphenationList.Name Property](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/name-property/llms-full.txt): Gets or sets the hyphenation list's name.
- [HyphenationList.UseOnlyCompoundHyphenationPoints Property](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/useonlycompoundhyphenationpoints-property/llms-full.txt): Gets or sets a value indicating whether words will be only hyphenated at compound junctions. The default value is false.

---

## Nearby

- **Previous:** [DictionaryRemovedEventArgs.Dictionary Property](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/dictionaryremovedeventargs/dictionary-property/llms-full.txt)
- **Next:** [HyphenationList Constructor](https://docs.textcontrol.com/tx-spell-dotnet-winforms/reference/txtextcontrol-proofing/hyphenationlist/constructor/llms-full.txt)