
		Forums Knowledge Base OfficeWriter Online


	This documentation is for OfficeWriter v3.8.1 .NET Platform View Docs for Another Version or Platform

Programmer's Reference > WordApplication API > WordHyphenSettings

The WordHyphenSettings Object

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

You cannot create a new WordHyphenSettings object. You must use the HyphenSettings property of the Document class 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.

Examples:

[csharp]

WordApplication app = new WordApplication();
Document doc = app.Open(@"C:\sample.doc");
WordHyphenSettings hyphenSettings = doc.HyphenSettings;

[vbnet]

Dim app As New WordApplication()
Dim doc As Document = app.Open("C:\sample.doc")
Dim hyphenSettings As WordHyphenSettings = doc.HyphenSettings

WordHyphenSettings Properties

Property	Type	Access	Description
AllowedConsecutiveHyphens	int	read write	Sets or returns an `int` that represents the number of consecutive lines that can be auto-hyphenated by Word in this document
AutoHyphen	boolean	read write	Sets or returns a `boolean` that represents whether or not Word will automatically hyphenate this document
CapitalHyphenation	boolean	read write	Sets or returns a `boolean` that represents whether or not Word is allowed to hyphenate words that are capitalized in this document
HyphenationWidth	int	read write	Sets or returns an `int` that represents the hyphenation width in twips for this document

This object does not have any methods defined.