Ruby 类

定义

命名空间:

DocumentFormat.OpenXml.Wordprocessing

程序集:

DocumentFormat.OpenXml.dll

包:

DocumentFormat.OpenXml v3.0.1

拼音指南。

此类在 Office 2007 及更高版本中可用。

当对象序列化为 xml 时，其限定名称为 w：ruby。

public class Ruby : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Ruby = class
    inherit OpenXmlCompositeElement

Public Class Ruby
Inherits OpenXmlCompositeElement

继承

Object

OpenXmlElement

OpenXmlCompositeElement

Ruby

注解

[ISO/IEC 29500-1 第 1 版]

ruby (拼音指南)

此元素指定文档中当前位置是否存在拼音指南。 拼音指南 (通常称为 ruby text) 是一个包含基文本的内容，该文本出现在此运行中的文本的正常基线位置，并在文档中的上面显示拼音指南文本。 生成的构造称为拼音指南，因为它通常用于将一种语言的单词映射到另一种语言的拼音。

基文本存储在 rubyBase 元素 (§17.3.3.27) 且参考文本存储在 rt 元素 (§17.3.3.24) 。

[示例：请考虑以下两个运行，每个运行包含拼音指南：

té00té00kyé京kyé

将使用以下 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>  

基文本包含在 rubyBase 元素中的运行中，指南文本包含在 rt 元素中的运行中。 示例结束]

父元素
r (§22.1.2.87) ;r (§17.3.2.25)

子元素	第
rt (拼音指南文本)	§17.3.3.24
rubyBase (拼音指南基文本)	§17.3.3.27
rubyPr (拼音指南属性)	§17.3.3.28

[注意：此元素的内容模型 (CT_Ruby) 的 W3C XML 架构定义位于 §A.1 中。 注释结束]

ISO/IEC29500：2008。

构造函数

Ruby()	初始化 Ruby 类的新实例。
Ruby(IEnumerable<OpenXmlElement>)	使用指定的子元素初始化 Ruby 类的新实例。
Ruby(OpenXmlElement[])	使用指定的子元素初始化 Ruby 类的新实例。
Ruby(String)	从外部 XML 初始化 Ruby 类的新实例。

属性

ChildElements	获取当前元素的所有子节点。 (继承自 OpenXmlElement)
ExtendedAttributes	获取当前元素的架构) 中未定义的所有扩展属性 (属性。 (继承自 OpenXmlElement)
Features	IFeatureCollection获取当前元素的 。 此功能集合将是只读的，但会从其父部件和包继承功能（如果可用）。 (继承自 OpenXmlElement)
FirstChild	获取当前 OpenXmlElement 元素的第一个子元素。 (继承自 OpenXmlCompositeElement)
HasAttributes	获取一个值，该值指示当前元素是否具有任何属性。 (继承自 OpenXmlElement)
HasChildren	获取一个值，该值指示当前元素是否具有任何子元素。 (继承自 OpenXmlCompositeElement)
InnerText	获取或设置当前节点及其所有子节点的串联值。 (继承自 OpenXmlCompositeElement)
InnerXml	获取或设置仅表示当前节点的子节点的标记。 (继承自 OpenXmlCompositeElement)
LastChild	获取当前 OpenXmlElement 元素的最后一个子元素。 如果没有这样的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlCompositeElement)
LocalName	获取当前元素的本地名称。 (继承自 OpenXmlElement)
MCAttributes	获取或设置标记兼容性属性。 如果未为当前元素定义标记兼容性属性，则返回 null。 (继承自 OpenXmlElement)
NamespaceDeclarations	获取在当前元素中定义的所有命名空间声明。 如果没有命名空间声明，则返回空枚举器。 (继承自 OpenXmlElement)
NamespaceUri	获取当前元素的命名空间 URI。 (继承自 OpenXmlElement)
OpenXmlElementContext	获取当前元素的 OpenXmlElementContext。 (继承自 OpenXmlElement)
OuterXml	获取表示当前元素及其所有子元素的标记。 (继承自 OpenXmlElement)
Parent	获取当前元素的父元素。 (继承自 OpenXmlElement)
Prefix	获取当前元素的命名空间前缀。 (继承自 OpenXmlElement)
RubyBase	拼音指南基文本。 表示架构中的以下元素标记：w：rubyBase。
RubyContent	拼音指南文本。 表示架构中的以下元素标记：w：rt。
RubyProperties	拼音指南属性。 表示架构中的以下元素标记：w：rubyPr。
XmlQualifiedName	获取当前元素的限定名称。 (继承自 OpenXmlElement)
XName	获取当前元素的限定名称。 (继承自 OpenXmlElement)

方法

AddAnnotation(Object)	将 对象添加到当前 OpenXmlElement 元素的批注列表中。 (继承自 OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	如果指定元素是已知的子元素，则将其添加到 元素。 这会根据架构将 元素添加到正确的位置。 (继承自 OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	将命名空间声明添加到当前节点。 (继承自 OpenXmlElement)
Ancestors()	枚举当前元素的所有上级。 (继承自 OpenXmlElement)
Ancestors<T>()	仅枚举具有指定类型的当前元素的上级。 (继承自 OpenXmlElement)
Annotation(Type)	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotation<T>()	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotations(Type)	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Annotations<T>()	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	将元素列表中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
Append(OpenXmlElement[])	将元素数组中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
AppendChild<T>(T)	将指定的元素追加到当前元素的子节点列表的末尾。 (继承自 OpenXmlCompositeElement)
ClearAllAttributes()	清除所有属性，包括已知属性和扩展属性。 (继承自 OpenXmlElement)
Clone()	创建当前节点的副本。 (继承自 OpenXmlElement)
CloneNode(Boolean)	创建此节点的副本。
Descendants()	枚举当前元素的所有后代。 (继承自 OpenXmlElement)
Descendants<T>()	枚举类型为 T 的当前元素的所有后代。 (继承自 OpenXmlElement)
Elements()	枚举当前元素的所有子元素。 (继承自 OpenXmlElement)
Elements<T>()	仅枚举具有指定类型的当前元素的子元素。 (继承自 OpenXmlElement)
ElementsAfter()	枚举与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
ElementsBefore()	枚举当前元素之前且具有与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
GetAttribute(String, String)	获取具有指定标记名称和命名空间 URI 的 Open XML 属性。 (继承自 OpenXmlElement)
GetAttributes()	获取一个列表，该列表包含所有属性的副本。 (继承自 OpenXmlElement)
GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)
GetFirstChild<T>()	查找类型 T 中的第一个子元素。 (继承自 OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	在指定的引用元素之后立即插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	在当前元素之后立即插入指定的元素。 (继承自 OpenXmlElement)
InsertAt<T>(T, Int32)	在当前元素的子元素的指定索引处插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	将指定的元素紧接在指定的引用元素之前。 (继承自 OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	将指定的元素紧接在当前元素的前面。 (继承自 OpenXmlElement)
IsAfter(OpenXmlElement)	确定当前元素是否以文档顺序显示在指定元素之后。 (继承自 OpenXmlElement)
IsBefore(OpenXmlElement)	确定当前元素是否按文档顺序显示在指定元素之前。 (继承自 OpenXmlElement)
LookupNamespace(String)	解析当前节点上下文中的命名空间前缀。 (继承自 OpenXmlElement)
LookupPrefix(String)	查找当前元素范围内命名空间 URI 的相应前缀。 (继承自 OpenXmlElement)
NextSibling()	获取紧跟在当前 OpenXmlElement 元素后面的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
NextSibling<T>()	获取具有当前 OpenXmlElement 元素后面的指定类型的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
PrependChild<T>(T)	在当前元素的子节点列表的开头插入指定的元素。 (继承自 OpenXmlCompositeElement)
PreviousSibling()	获取紧接在当前 OpenXmlElement 元素之前的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic ) 中 Nothing。 (继承自 OpenXmlElement)
PreviousSibling<T>()	获取位于当前 OpenXmlElement 之前的指定类型的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
Remove()	从其父元素中删除当前元素。 (继承自 OpenXmlElement)
RemoveAllChildren()	删除当前元素的所有子元素。 (继承自 OpenXmlCompositeElement)
RemoveAllChildren<T>()	删除类型为 T 的当前元素的所有子元素。 (继承自 OpenXmlElement)
RemoveAnnotations(Type)	从当前 OpenXmlElement 元素中删除指定类型的注释。 (继承自 OpenXmlElement)
RemoveAnnotations<T>()	从当前 OpenXmlElement 元素中删除具有指定类型的批注。 (继承自 OpenXmlElement)
RemoveAttribute(String, String)	从当前元素中删除 属性。 (继承自 OpenXmlElement)
RemoveChild<T>(T)	删除指定的子元素。 (继承自 OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	删除指定前缀的命名空间声明。 如果没有前缀，则不删除任何内容。 (继承自 OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	将当前元素的子元素之一替换为另一个 OpenXmlElement 元素。 (继承自 OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	将特性设置为指定的元素。 如果该属性是已知属性，则设置该特性的值。 如果该属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	设置元素的多个属性。 如果属性是已知属性，则会设置该属性的值。 如果属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
WriteTo(XmlWriter)	将当前节点保存到指定的 XmlWriter。 (继承自 OpenXmlElement)

显式接口实现

IEnumerable.GetEnumerator()	拼音指南。 此类在 Office 2007 及更高版本中可用。 当对象序列化为 xml 时，其限定名称为 w：ruby。 (继承自 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)