Ruby Class
Phonetic Guide.When the object is serialized out as xml, its qualified name is w:ruby.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Wordprocessing.Ruby
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(RubyContent))> _
<ChildElementInfoAttribute(GetType(RubyBase))> _
<ChildElementInfoAttribute(GetType(RubyProperties))> _
Public Class Ruby _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As Ruby
[ChildElementInfoAttribute(typeof(RubyContent))]
[ChildElementInfoAttribute(typeof(RubyBase))]
[ChildElementInfoAttribute(typeof(RubyProperties))]
public class Ruby : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
RubyProperties <w:rubyPr>
RubyContent <w:rt>
RubyBase <w:rubyBase>
[ISO/IEC 29500-1 1st Edition]
17.3.3.25 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 (§17.3.3.27) and the guide text is stored in the rt element (§17.3.3.24).
[Example: Consider the following two runs, each containing a phonetic guide:
tō東tō東kyō京kyō京
The first run would be specified using the following WordprocessingML:
<w:r> <w:ruby> <w:rubyPr> … </w:rubyPr> <w:rt> … <w:r> <w:t>tō</w:t> </w:r> </w:rt> <w:rubyBase> … <w:r> <w:t>東</w:t> </w:r> </w:rubyBase> </w:ruby> </w:r>
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 (§22.1.2.87); r (§17.3.2.25) |
Child Elements |
Subclause |
|---|---|
rt (Phonetic Guide Text) |
§17.3.3.24 |
rubyBase (Phonetic Guide Base Text) |
§17.3.3.27 |
rubyPr (Phonetic Guide Properties) |
§17.3.3.28 |
[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.