Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Description

Excerpt

This class is used to get and set Word hyphen settings for a document.

Signature
C#
C#

<p> public sealed class WordHyphenSettings
{signature}{signature:WordHyphenSettings</p>
} Public
Signature
vb.net
vb.net

<p>Public NotInheritable Class WordHyphenSettings
{signature}
{remarks}You cannot create a new {{WordHyphenSettings}} object. You must use the [Document.HyphenSettings] property to retrieve WordHyphenSettings properties for a document.

The following sample gets the {{WordHyphenSettings}} object of a document so you can start working with these properties.

{remarks}
{example}{code:csharp|title=C#}WordHyphenSettings</p>
Remarks

You cannot create a new WordHyphenSettings object. You must use the Document.HyphenSettings property to retrieve WordHyphenSettings properties for a document.

The following sample gets the WordHyphenSettings object of a document so you can start working with these properties.

Example
Code Block
csharp
csharp
titleC#


          WordApplication app = new WordApplication();
          Document doc = app.Open(@"C:\sample.doc");
          WordHyphenSettings hyphenSettings = doc.HyphenSettings;
        
{code} {code:
Code Block
vb.net
|title=
vb.net
titlevb.net
}


          Dim app As New WordApplication()
          Dim doc As Document = app.Open("C:\sample.doc")
          Dim hyphenSettings As WordHyphenSettings = doc.HyphenSettings
        
{code} {example} {properties} ||Name||Description|| |[AllowedConsecutiveHyphens|WordHyphenSettings.AllowedConsecutiveHyphens]|{excerpt-include:WordHyphenSettings.AllowedConsecutiveHyphens|nopanel=true}| |[AutoHyphen|WordHyphenSettings.AutoHyphen]|{excerpt-include:WordHyphenSettings.AutoHyphen|nopanel=true}| |[CapitalHyphenation|WordHyphenSettings.CapitalHyphenation]|{excerpt-include:WordHyphenSettings.CapitalHyphenation|nopanel=true}| |[HyphenationWidth|WordHyphenSettings.HyphenationWidth]|{excerpt-include:WordHyphenSettings.HyphenationWidth|nopanel=true}|
Properties

Name

Description

AllowedConsecutiveHyphens

Excerpt Include
WordHyphenSettings.AllowedConsecutiveHyphens
WordHyphenSettings.AllowedConsecutiveHyphens
nopaneltrue

AutoHyphen

Excerpt Include
WordHyphenSettings.AutoHyphen
WordHyphenSettings.AutoHyphen
nopaneltrue

CapitalHyphenation

Excerpt Include
WordHyphenSettings.CapitalHyphenation
WordHyphenSettings.CapitalHyphenation
nopaneltrue

HyphenationWidth

Excerpt Include
WordHyphenSettings.HyphenationWidth
WordHyphenSettings.HyphenationWidth
nopaneltrue