RubyAlign class

Office 2013 and later

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

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

public class RubyAlign : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

rubyAlign (Phonetic Guide Text Alignment)

This element specifies the alignment setting which shall be used to determine the placement of phonetic guide text with respect to the base text when this phonetic guide is displayed.

[Example: Consider a run of phonetic guide text which must have the ruby text positioned to the far left of the base text. This constraint is specified using the following WordprocessingML:

<w:rubyPr>
  …  <w:rubyAlign w:val="left"/>
  …</w:rubyPr>

The rubyAlign property is left for the phonetic guide, so the ruby text is displayed on the left side of the base text. end example]

Parent Elements

rubyPr (§17.3.3.28)

Attributes

Description

val (Phonetic Guide Text Alignment Value)

Specifies the type of alignment to be applied to the phonetic guide text.

[Example: Consider a run of phonetic guide text which must have the ruby text positioned to the far right of the base text. This constraint is specified using the following WordprocessingML:

<w:rubyPr>
  …  <w:rubyAlign w:val="left"/>
  …</w:rubyPr>

The value of the val attribute is right for the phonetic guide, so the ruby text is displayed on the right side of the base text. end example]

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

[Note: The W3C XML Schema definition of this element’s content model (CT_RubyAlign) is located in §A.1. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: