Class PatternHyphenationDictionary

Provides hyphenation points from TeX-style patterns and language-specific exceptions.

Inheritance

object

HyphenationDictionary

PatternHyphenationDictionary

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: DRIT.Document

Assembly: DRIT.Document.dll

Syntax

public sealed class PatternHyphenationDictionary : HyphenationDictionary

Constructors

PatternHyphenationDictionary(IEnumerable<string>, IDictionary<string, IEnumerable<int>>, int, int)

Initializes a pattern-based dictionary.

Declaration

public PatternHyphenationDictionary(IEnumerable<string> patterns, IDictionary<string, IEnumerable<int>> exceptions = null, int leftMinimum = 2, int rightMinimum = 2)

Parameters

Type	Name	Description
IEnumerable<string>	patterns	TeX-style patterns, such as 1ba or a1b.
IDictionary<string, IEnumerable<int>>	exceptions	Words mapped to explicit zero-based split positions.
int	leftMinimum	Minimum number of letters before a split.
int	rightMinimum	Minimum number of letters after a split.

Methods

Hyphenate(string)

Gets the possible hyphenation positions for a word.

Declaration

public override IList<int> Hyphenate(string word)

Parameters

Type	Name	Description
string	word	The word to hyphenate.

Returns

Type	Description
IList<int>	A list of zero-based split positions, or an empty list when no split is known.

Overrides

HyphenationDictionary.Hyphenate(string)