Class HyphenationOptions

Controls hyphenation policy during PDF export.

Inheritance

object

HyphenationOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: DRIT.Document.Export.Pdf

Assembly: DRIT.Document.dll

Syntax

public sealed class HyphenationOptions

Properties

EmitDiscretionaryHyphen

Gets or sets whether a visible hyphen is emitted when a discretionary break is used.

Declaration

public bool EmitDiscretionaryHyphen { get; set; }

Property Value

Type	Description
bool

Enabled

Gets or sets whether PDF export should use dictionary hyphenation. A null value follows AutoHyphenation.

Declaration

public bool? Enabled { get; set; }

Property Value

Type	Description
bool?

Language

Gets or sets the export-wide language fallback used when a run does not provide one.

Declaration

public string Language { get; set; }

Property Value

Type	Description
string

MinimumPrefixLength

Gets or sets the minimum number of characters retained before a discretionary break.

Declaration

public int MinimumPrefixLength { get; set; }

Property Value

Type	Description
int

Exceptions

Type	Condition
ArgumentOutOfRangeException	The value is negative.

MinimumSuffixLength

Gets or sets the minimum number of characters retained after a discretionary break.

Declaration

public int MinimumSuffixLength { get; set; }

Property Value

Type	Description
int

Exceptions

Type	Condition
ArgumentOutOfRangeException	The value is negative.

MissingDictionaryBehavior

Gets or sets the behavior when no dictionary is available for a requested language.

Declaration

public HyphenationMissingDictionaryBehavior MissingDictionaryBehavior { get; set; }

Property Value

Type	Description
HyphenationMissingDictionaryBehavior

TreatSoftHyphenAsOpportunity

Gets or sets whether an explicit soft hyphen is considered a discretionary break.

Declaration

public bool TreatSoftHyphenAsOpportunity { get; set; }

Property Value

Type	Description
bool

UseDocumentSettings

Gets or sets whether a null Enabled value follows the document's AutoHyphenation setting.

Declaration

public bool UseDocumentSettings { get; set; }

Property Value

Type	Description
bool