EastAsianLayout class

Office 2013 and later

Defines the EastAsianLayout Class. When the object is serialized out as xml, its qualified name is w:eastAsianLayout.

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.EastAsianLayout

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

public class EastAsianLayout : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

eastAsianLayout (East Asian Typography Settings)

This element specifies any East Asian typography settings which shall be applied to the contents of the run.

The specific typography settings represented by this element include the two lines in one and horizontal in vertical text options.

The two lines in one setting specifies that the characters in this run should be written out on a single line in the document by creating two sub-lines within the regular line, and laying out this text equally between those sub lines.

[Example: Consider a paragraph with the text two lines in one, which must be displayed within a single logical line in the document. This constraint would be specified as follows in the WordprocessingML:

<w:r>
  <w:rPr>
    <w:eastAsianLayout w:id="1" w:combine="on" />
  </w:rPr>
  <w:t>two lines in one</w:t>
</w:r>

The resulting text would be displayed on two sub lines within the other text on this line, like this:

end example]

The horizontal in vertical setting specifies that characters in this run should be rendered with a 90 degree rotation to the left from all other contents of the line when displayed in the document, while keeping the text on the same line as all other text in the paragraph.

[Example: Consider a paragraph with the text this word is vertical, of which the word vertical must be displayed vertically within the document. This constraint would be specified as follows in the WordprocessingML:

<w:r>
  <w:rPr>
    <w:eastAsianLayout w:id="2" w:vert="on" />
  </w:rPr>
  <w:t>vertical</w:t>
</w:r>

The resulting text would be displayed with a 90 degree rotation from the other text content. end example]

Parent Elements

rPr (§17.3.1.29); rPr (§17.3.1.30); rPr (§17.5.2.28); rPr (§17.9.25); rPr (§17.7.9.1); rPr (§17.7.5.4); rPr (§17.3.2.28); rPr (§17.5.2.27); rPr (§17.7.6.2); rPr (§17.3.2.27)

Attributes

Description

combine (Two Lines in One)

Specifies whether the contents of the current run should be combined into one line using the two lines in one logic described above in the parent element.

If this attribute is omitted, then this run shall not be displayed on two sub lines.

[Example: Consider a paragraph with the text two lines in one, which must be displayed within a single logical line in the document. This constraint would be specified as follows in the WordprocessingML:

<w:r>
  <w:rPr>
    <w:eastAsianLayout w:id="1" w:combine="on" />
  </w:rPr>
  <w:t>two lines in one</w:t>
</w:r>

The resulting text would be displayed on two sub lines within the other text on this line. end example]

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

combineBrackets (Display Brackets Around Two Lines in One)

Specifies that the two lines in one text should be enclosed within a pair of brackets when displayed. This attribute's values determine the bracket style to put around combined text.

If this attribute is not specified, then no brackets shall be placed around this content when displayed in the document. If the combine attribute is not specified, then this attribute is ignored.

[Example: Consider a paragraph with the text two lines in one, which must be displayed within a single logical line in the document and enclosed in curly brackets. This constraint would be specified as follows in the WordprocessingML:

<w:r>
  <w:rPr>
    <w:eastAsianLayout w:id="1" w:combine="on" w:combineBrackets="curly"/>
  </w:rPr>
  <w:t>two lines in one</w:t>
</w:r>

The resulting text would be displayed on two sub lines within the other text on this line and enclosed within curly brackets when displayed. end example]

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

id (East Asian Typography Run ID)

Specifies a unique ID which shall be used to link multiple runs containing eastAsianLayout element to each other to ensure that their contents are correctly displayed in the document.

This means that multiple runs which are broken apart due to differences in formatting can be identified as belonging to the same grouping in terms of eastAsianLayout properties, although they are separated into multiple runs of text.

[Example: Consider the following three runs in a document:

<w:r>
  <w:rPr>
    <w:eastAsianLayout w:id="-1552701694" w:combine="lines" w:combineBrackets="curly" /> 
  </w:rPr>
  <w:t>two</w:t> 
</w:r>
<w:r>
  <w:rPr>
    <w:u w:val="single" w:color="4F81BD" w:themeColor="accent1" /> 
    <w:eastAsianLayout w:id="-1552701694" w:combine="lines" w:combineBrackets="curly" /> 
  </w:rPr>
  <w:t>lines in</w:t> 
</w:r>
<w:r>
  <w:rPr>
  <w:eastAsianLayout w:id="-1552701694" w:combine="lines" w:combineBrackets="curly" /> 
  </w:rPr>
  <w:t>one</w:t> 
</w:r>

Although there are three runs of content, all three regions must be combined into a single two lines in one region based on the identical value used in the id attribute for all three runs. end example]

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

vert (Horizontal in Vertical (Rotate Text))

Specifies that characters in this run should be rendered with a 270 degree rotation to the left from all other contents of the line when displayed in the document as described above.

If this attribute is omitted, then the contents of this run shall not be rotated with respect to the normal text flow.

[Example: Consider a paragraph with the text this word is vertical, of which the word vertical must be displayed vertically within the document. This constraint would be specified as follows in the WordprocessingML:

<w:r>
  <w:rPr>
    <w:eastAsianLayout w:id="2" w:vert="on" />
  </w:rPr>
  <w:t>vertical</w:t>
</w:r>

The resulting text would be displayed with a 270 degree rotation from the other text content. end example]

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

vertCompress (Compress Rotated Text to Line Height)

Specifies whether the rotated text shall be compressed at display time in order to ensure that it fits into the existing line height without increasing the overall height of the line.

If the vert attribute is not specified, then this attribute is ignored. If this attribute is omitted, then text shall not be compressed in order to fit into the existing height of the line when it is rotated.

[Example: Consider a paragraph with the text this word is vertical, of which the word vertical must be displayed vertically within the document but must not change the height of the line. This constraint would be specified as follows in the WordprocessingML:

<w:r>
  <w:rPr>
    <w:eastAsianLayout w:id="2" w:vert="true" w:vertCompress="true" />
  </w:rPr>
  <w:t>vertical</w:t>
</w:r>

The resulting text would be compressed in order to fit the height of the line as defined by all non-compressed characters. end example]

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

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