Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Description

Excerpt

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

Signature
C#C#
Wiki Markup
{description}
{excerpt}This class is used to get and set Word hyphen settings for a document.{excerpt}
{signature:C#}
 public sealed class WordHyphenSettings
Signature
{signature}{signature:vb.net
vb.net
}
Public NotInheritable Class WordHyphenSettings
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.

{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#}

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

          Dim app As New WordApplication()
          Dim doc As Document = app.Open("C:\sample.doc")
          Dim hyphenSettings As WordHyphenSettings = doc.HyphenSettings
        
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle
Properties

...

Name

...

Description

...

AllowedConsecutiveHyphens

...

{code}

{example}
{properties}
||Name||Description||
|[AllowedConsecutiveHyphens|WordHyphenSettings.AllowedConsecutiveHyphens]|{excerpt-include:WordHyphenSettings.AllowedConsecutiveHyphens

...

AutoHyphen

|nopanel=true}|
|[AutoHyphen|WordHyphenSettings.AutoHyphen]|{excerpt-include

...

:WordHyphenSettings.AutoHyphen

...

CapitalHyphenation

|nopanel=true}|
|[CapitalHyphenation|WordHyphenSettings.CapitalHyphenation]|{excerpt-include

...

:WordHyphenSettings.CapitalHyphenation

...

HyphenationWidth

|nopanel=true}|
|[HyphenationWidth|WordHyphenSettings.HyphenationWidth]|{excerpt-include

...

:WordHyphenSettings.HyphenationWidth

...

|nopanel=true}|