Ruby Class

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

Inheritance Hierarchy


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


<ChildElementInfoAttribute(GetType(RubyContent))> _
<ChildElementInfoAttribute(GetType(RubyBase))> _
<ChildElementInfoAttribute(GetType(RubyProperties))> _
Public Class Ruby _
    Inherits OpenXmlCompositeElement
Dim instance As Ruby
public class Ruby : OpenXmlCompositeElement


The following table lists the possible child types:

  • RubyProperties <w:rubyPr>

  • RubyContent <w:rt>

  • RubyBase <w:rubyBase>

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

This element specifies the presence of a phonetic guide at the current location in the document. A phonetic guide (often called ruby text) is a run of content with base text which appears at the normal baseline location for text in this run, with phonetic guide text displayed above it in the document. The resulting construct is called a phonetic guide as it is typically used to map words in one language to another phonetically.

The base text is stored in the rubyBase element (§ and the guide text is stored in the rt element (§

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


The first run would be specified using the following WordprocessingML:


The base text is contained in a run within the rubyBase element, and the guide text is contained in a run within the rt element. end example]

Parent Elements

r (§; r (§

Child Elements


rt (Phonetic Guide Text)


rubyBase (Phonetic Guide Base Text)


rubyPr (Phonetic Guide Properties)


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


Ruby Members

DocumentFormat.OpenXml.Wordprocessing Namespace