SpaceForUnderline Class

Add Additional Space Below Baseline For Underlined East Asian Text.When the object is serialized out as xml, its qualified name is w:spaceForUL.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class SpaceForUnderline _
    Inherits OnOffType
'Usage
Dim instance As SpaceForUnderline
public class SpaceForUnderline : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.3.7 spaceForUL (Add Additional Space Below Baseline For Underlined East Asian Text)

This element specifies whether East Asian content in a WordprocessingML document which has been underlined using the u element shall have additional descent added to the properties of the font in order to ensure that there is adequate spacing between the characters in the font and the underlining applied to the text.

Typically, no adjustments are made to the contents of text runs containing East Asian text which have been underlined. This element, when present with a val attribute value of true (or equivalent), specifies that whenever the following conditions are met:

  • The text run contains East Asian characters

  • The text run is not using baseline font alignment as defined by the textAlignment property

That the larger of the following two values is added to the descent property of that font in order to provide additional padding between the text characters and the underline:

  • 3 percent of the font size

  • 40 twentieths of a point (31 twentieths of a point for Japanese text)

[Example: Consider a WordprocessingML document consisting of a single run of underlined Japanese text, as follows:

<w:p>
<w:r>
<w:rPr>
<w:u w:val="double" />
</w:rPr>
<w:t>クリスタ</w:t>
</w:r>
</w:p>

If this document is displayed, then the text is laid out along with the underline, as follows:

DocumentFormat.OpenXml.Wordprocessing.SpaceForUnde

However, if this compatibility setting is turned on:

<w:compat>
<w:spaceForUL />
</w:compat>

Then the additional descent specified using the logic above is added to the text, resulting in the following output:

DocumentFormat.OpenXml.Wordprocessing.SpaceForUnde

end example]

Parent Elements

compat (§17.15.1.21)

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

SpaceForUnderline Members

DocumentFormat.OpenXml.Wordprocessing Namespace