ConsecutiveHyphenLimit Class
Maximum Number of Consecutively Hyphenated Lines.When the object is serialized out as xml, its qualified name is w:consecutiveHyphenLimit.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.ConsecutiveHyphenLimit
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class ConsecutiveHyphenLimit _
Inherits OpenXmlLeafElement
'Usage
Dim instance As ConsecutiveHyphenLimit
public class ConsecutiveHyphenLimit : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
17.15.1.22 consecutiveHyphenLimit (Maximum Number of Consecutively Hyphenated Lines)
This element specifies the maximum number of consecutive lines of text that can end with a hyphen when the contents of this document are displayed. Once this limit has been reached, the following line shall not be hyphenated regardless of whether or not it meets the criteria needed for hyphenation.
If this element is omitted or has its val attribute equal to 0, the given WordprocessingML document shall have no limit on the number of consecutive lines of text that can end with a hyphen.
[Example: Consider a WordprocessingML document which should automatically be hyphenated. If the contents of this document result in hyphens appearing on every line in the document, as follows:
.gif "DocumentFormat.OpenXml.Wordprocessing.ConsecutiveH")
This output might be undesirable. If the document shall have a maximum of two consecutive hyphens, this requirement is specified using the following WordprocessingML in the document settings:
<w:consecutiveHyphenLimit w:val="2" />
The consecutiveHyphenLimit element's val attribute has a value of 2 specifying that a maximum of two hyphens should be allowed, limiting the hyphenation output like this:
.gif "DocumentFormat.OpenXml.Wordprocessing.ConsecutiveH")
end example]
Parent Elements |
|---|
settings (§17.15.1.78) |
Attributes |
Description |
|---|---|
val (Decimal Number Value) |
Specifies that the contents of this attribute contains a decimal number. The contents of this decimal number are interpreted based on the context of the parent XML element. [Example: Consider the following numeric WordprocessingML property of simple type ST_DecimalNumber: <… w:val="1512645511" /> The value of the val attribute is a decimal number whose value must be interpreted in the context of the parent element. end example] The possible values for this attribute are defined by the ST_DecimalNumber simple type (§17.18.10). |
[Note: The W3C XML Schema definition of this element’s content model (CT_DecimalNumber) 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.