RubyProperties Class

Phonetic Guide Properties.When the object is serialized out as xml, its qualified name is w:rubyPr.

Inheritance Hierarchy


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


<ChildElementInfoAttribute(GetType(PhoneticGuideTextFontSize))> _
<ChildElementInfoAttribute(GetType(RubyAlign))> _
<ChildElementInfoAttribute(GetType(PhoneticGuideBaseTextSize))> _
<ChildElementInfoAttribute(GetType(Dirty))> _
<ChildElementInfoAttribute(GetType(PhoneticGuideRaise))> _
<ChildElementInfoAttribute(GetType(LanguageId))> _
Public Class RubyProperties _
    Inherits OpenXmlCompositeElement
Dim instance As RubyProperties
public class RubyProperties : OpenXmlCompositeElement


The following table lists the possible child types:

  • RubyAlign <w:rubyAlign>

  • PhoneticGuideTextFontSize <w:hps>

  • PhoneticGuideRaise <w:hpsRaise>

  • PhoneticGuideBaseTextSize <w:hpsBaseText>

  • LanguageId <w:lid>

  • Dirty <w:dirty>

[ISO/IEC 29500-1 1st Edition] rubyPr (Phonetic Guide Properties)

This element specifies a set of properties which determine the behavior and appearance of a phonetic guide within the document.

[Example: Consider the following two runs, each containing a phonetic guide:


The properties for both of these phonetic guides are as follows:

<w:rubyAlign w:val="distributeSpace" />
<w:hps w:val="16" />
<w:hpsRaise w:val="20" />
<w:hpsBaseText w:val="22" /> 
      <w:lid w:val="ja-JP" /> 

The phonetic guide properties specify that the guide text must be:

  • Distributed across the top (using the rubyAlign element)

  • 8 point font face (using the hps element)

  • 10 points above the base text (using the hpaRaise element)

  • Japanese (using the lid element)

As well, the phonetic guide properties specify that the base text must be:

  • 11 point font face (using the hpsBaseText element)

end example]

Parent Elements

ruby (§

Child Elements


dirty (Invalidated Field Cache)


hps (Phonetic Guide Text Font Size)


hpsBaseText (Phonetic Guide Base Text Font Size)


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


lid (Language ID for Phonetic Guide)


rubyAlign (Phonetic Guide Text Alignment)


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


RubyProperties Members

DocumentFormat.OpenXml.Wordprocessing Namespace