HyphenationZone Class
Hyphenation Zone.When the object is serialized out as xml, its qualified name is w:hyphenationZone.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.TwipsMeasureType
DocumentFormat.OpenXml.Wordprocessing.HyphenationZone
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class HyphenationZone _
Inherits TwipsMeasureType
'Usage
Dim instance As HyphenationZone
public class HyphenationZone : TwipsMeasureType
Remarks
[ISO/IEC 29500-1 1st Edition]
17.15.1.53 hyphenationZone (Hyphenation Zone)
This element specifies the hyphenation zone which shall be used when automatically or manually hyphenating the contents of this document. The hyphenation zone is the amount of whitespace which can be left at the end of a line (or added to justified lines) before hyphenation should be attempted on the next word in the document (in order to reduce the amount of whitespace on the line). A smaller hyphenation zone should reduce the raggedness of the right edge of a given document's body text, as more words is hyphenated. Conversely, a larger hyphenation zone should increase the raggedness of the right edge of a given document's text, as fewer words is hyphenated.
If this element is omitted, then a default hyphenation zone of 360 twentieths of a point (0.25") shall be applied when performing hyphenation on this document.
[Example: Consider the images below illustrating a paragraph of text in a WordprocessingML document which was automatically hyphenated with the default hyphenation zone:
.jpg "DocumentFormat.OpenXml.Wordprocessing.HyphenationZ")
If document must instead be hyphenated using a hyphenation zone of one-half of an inch, that requirement would be specified using the following WordprocessingML in the document settings:
<w:hyphenationZone w:val="720" />
The resulting output would only hyphenate words when the remaining line whitespace was less than half an inch, and would look like the following:
.jpg "DocumentFormat.OpenXml.Wordprocessing.HyphenationZ")
The hyphenationZone element has its val attribute equal to 720, therefore lines in the document are hyphenated when the remaining line spacing is less than 72o twentieths of a point (0.5"), resulting in fewer hyphens. end example]
Parent Elements |
|---|
settings (§17.15.1.78) |
Attributes |
Description |
|---|---|
val (Measurement in Twentieths of a Point) |
Specifies a positive measurement value, specified in twentieths of a point. This value is interpreted based on the context of the parent XML element. [Example: Consider the following WordprocessingML element with a val attribute containing a positive measurement in twentieths of a point: <… w:val="720" /> The val attribute has a value of 720, specifying that this measurement value is 720 twentieths of a point (0.5"). This value is interpreted by the parent element as needed. end example] The possible values for this attribute are defined by the ST_TwipsMeasure simple type (§22.9.2.14). |
[Note: The W3C XML Schema definition of this element’s content model (CT_TwipsMeasure) is located in §A.1. end note]
© 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.