GemBox.Document
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    HyphenationOptions Class

    Namespace:
    GemBox.Document
    Assembly:
    GemBox.Document.dll

    Represents the hyphenation options for the DocumentModel.

    • C#
    • VB.NET
    public sealed class HyphenationOptions
    Public NotInheritable Class HyphenationOptions
    Inheritance:
    System.Object
    HyphenationOptions

    Constructors

    HyphenationOptions()

    Initializes a new instance of the HyphenationOptions class.

    • C#
    • VB.NET
    public HyphenationOptions()
    Public Sub New

    Properties

    AutoHyphenation

    Gets or sets a value indicating whether automatic hyphenation is turned on for the specified document.

    • C#
    • VB.NET
    public bool AutoHyphenation { get; set; }
    Public Property AutoHyphenation As Boolean
    Property Value
    System.Boolean

    true if automatic hyphenation is turned on for the specified document; otherwise, false.

    ConsecutiveHyphensLimit

    Gets or sets the maximum number of consecutive lines that can end with hyphens.

    • C#
    • VB.NET
    public int ConsecutiveHyphensLimit { get; set; }
    Public Property ConsecutiveHyphensLimit As Integer
    Property Value
    System.Int32

    The maximum number of consecutive lines that can end with hyphens.

    Remarks

    Consecutive hyphens limit value can be between 0 and 32767. Default value is 0.

    HyphenateCaps

    Gets or sets a value indicating whether words in all capital letters can be hyphenated.

    • C#
    • VB.NET
    public bool HyphenateCaps { get; set; }
    Public Property HyphenateCaps As Boolean
    Property Value
    System.Boolean

    true if words in all capital letters can be hyphenated; otherwise, false.

    HyphenationZone

    Gets or sets the width of the hyphenation zone, in points.

    Default value is 18 points (0.25 inch).

    • C#
    • VB.NET
    public double HyphenationZone { get; set; }
    Public Property HyphenationZone As Double
    Property Value
    System.Double

    The width of the hyphenation zone, in points.

    Remarks

    The hyphenation zone is the maximum amount of space left between the end of the last word in a line and the right margin.

    Methods

    Clone()

    Clones this HyphenationOptions instance.

    • C#
    • VB.NET
    public HyphenationOptions Clone()
    Public Function Clone As HyphenationOptions
    Returns
    HyphenationOptions

    Cloned HyphenationOptions.

    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.