AutoHyphenation Class

Automatically Hyphenate Document Contents When Displayed.When the object is serialized out as xml, its qualified name is w:autoHyphenation.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.OnOffType
        DocumentFormat.OpenXml.Wordprocessing.AutoHyphenation

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
Public Class AutoHyphenation _
    Inherits OnOffType
'Usage
Dim instance As AutoHyphenation

public class AutoHyphenation : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.1.10 autoHyphenation (Automatically Hyphenate Document Contents When Displayed)

This element specifies whether the content of a given WordprocessingML document should automatically be hyphenated by the hosting application before it is displayed, if the application supports this functionality.

If this element is omitted, then hyphenation shall not automatically be performed by application displaying this document.

[Example: Consider the images below illustrating a paragraph of text in a WordprocessingML document:

If the content in this document must automatically be hyphenated when it is displayed, that requirement would be specified using the following WordprocessingML in the document settings:

<w:autoHyphenation w:val="true" />

The resulting output might look like the following (depending on the application's hyphenation algorithm and the hyphenation zone setting (§17.15.1.53):

The autoHypehenation element has its val attribute equal to true, the document is automatically hyphenated and the word sample, beginning at the end of the second line, is hyphenated automatically and thus carried over onto the third line. Conversely, when the autoHypehnation element has its val attribute equal to off, the entire word sample is carried over to the third line as it was not hyphenated automatically and could not fit onto the second line. end example]

Parent Elements
settings (§17.15.1.78)

This element’s content model is defined by the common boolean property definition in §17.17.4.

© ISO/IEC29500: 2008.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

AutoHyphenation Members

DocumentFormat.OpenXml.Wordprocessing Namespace