PhoneticGuideRaise Class

Distance Between Phonetic Guide Text and Phonetic Guide Base Text.When the object is serialized out as xml, its qualified name is w:hpsRaise.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.PhoneticGuideRaise

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

Syntax

'Declaration
Public Class PhoneticGuideRaise _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As PhoneticGuideRaise
public class PhoneticGuideRaise : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.3.3.12 hpsRaise (Distance Between Phonetic Guide Text and Phonetic Guide Base Text)

This element specifies the distance which shall be left between the phonetic guide base text and the phonetic guide text when this phonetic guide text is displayed.

[Example: Consider a run of phonetic guide text which must have 10 points between the phonetic guide base text and the phonetic guide text. This constraint is specified using the following WordprocessingML:

<w:rubyPr>
…
<w:hpsRaise w:val="20"/>
  …
</w:rubyPr>

The hpsRaise property is 20 half-points for the phonetic guide, so the phonetic guide text is displayed 10 points above the phonetic guide base text. end example]

Parent Elements

rubyPr (§17.3.3.28)

Attributes

Description

val (Half Point Measurement)

Specifies a positive measurement specified in half-points (1/144 of an inch).

The contents of this attribute value are interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML fragment:

<… w:val="30" />

The value in the val attribute is 30, which is equivalent to 15 points (30 half-points).

This value is interpreted in the context of the parent element. end example]

The possible values for this attribute are defined by the ST_HpsMeasure simple type (§17.18.42).

[Note: The W3C XML Schema definition of this element’s content model (CT_HpsMeasure) 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.

See Also

Reference

PhoneticGuideRaise Members

DocumentFormat.OpenXml.Wordprocessing Namespace