Class HyphenationConfig

Namespace

iText.Layout.Hyphenation

Assembly

itext.layout.dll

This is the class used to configure hyphenation on layout level

public class HyphenationConfig

Inheritance

object

HyphenationConfig

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

HyphenationConfig(int, int)

Constructs a new HyphenationConfig.

public HyphenationConfig(int leftMin, int rightMin)

Parameters

leftMin int

the minimum number of characters before the hyphenation point

rightMin int

the minimum number of characters after the hyphenation point

Remarks

Constructs a new HyphenationConfig . No language hyphenation files will be used. Only soft hyphen symbols ('\u00ad') will be taken into account.

HyphenationConfig(string, string, int, int)

Constructs a new HyphenationConfig instance.

public HyphenationConfig(string lang, string country, int leftMin, int rightMin)

Parameters

lang string

the language

country string

the optional country code (may be null or "none")

leftMin int

the minimum number of characters before the hyphenation point

rightMin int

the minimum number of characters after the hyphenation point

HyphenationConfig(Hyphenator)

Constructs a new HyphenationConfig by a Hyphenator which will be used to find hyphenation points.

public HyphenationConfig(Hyphenator hyphenator)

Parameters

hyphenator Hyphenator

the Hyphenator instance

Fields

hyphenSymbol

The hyphenation symbol used when hyphenating.

protected char hyphenSymbol

Field Value

char

hyphenator

The Hyphenator object.

protected Hyphenator hyphenator

Field Value

Hyphenator

Methods

GetHyphenSymbol()

Gets the hyphenation symbol.

public virtual char GetHyphenSymbol()

Returns

char

the hyphenation symbol

Hyphenate(string)

Hyphenates a given word.

public virtual Hyphenation Hyphenate(string word)

Parameters

word string

Tee word to hyphenate

Returns

Hyphenation

Hyphenation object representing possible hyphenation points or null if no hyphenation points are found.

SetHyphenSymbol(char)

Sets the hyphenation symbol to the specified value.

public virtual void SetHyphenSymbol(char hyphenSymbol)

Parameters

hyphenSymbol char

the new hyphenation symbol