EquationArray Class

  • Article

Equation-Array Function.When the object is serialized out as xml, its qualified name is m:eqArr.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Math.EquationArray

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(EquationArrayProperties))> _
<ChildElementInfoAttribute(GetType(Base))> _
Public Class EquationArray _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As EquationArray

[ChildElementInfoAttribute(typeof(EquationArrayProperties))]
[ChildElementInfoAttribute(typeof(Base))]
public class EquationArray : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • EquationArrayProperties <m:eqArrPr>

  • Base <m:e>

[ISO/IEC 29500-1 1st Edition]

22.1.2.34 eqArr (Array Object)

This element specifies the Array object (sometimes referred to as "Equation Array", despite its ability to hold mathematical text other than equations), an object consisting of one or more equations, expressions, or other mathematical text runs that can be vertically justified as a unit with respect to surrounding text on the line. Alignment of multiple points within each run of mathematical text can occur within the array through the use of align values and spacer values. An align value is an ampersand within the array which acts as an alignment point (as described in §22.1.2.3). A spacer value is an ampersand (represented by "&amp;" in the example below) within the array which designates where space can be added in order to align the align values on different rows of the array. Within each argument in the array, every odd ampersand is an align value and every even ampersand is a spacer value (as well, the beginning of each argument provides an implied spacer value). If eqArrPr is omitted then the default values for its properties will be used. These defaults are:

Property

Default Value

baseJc

“center”

ctrlPr

‎<The character property of the first control character will be the character property of the first character ‎in the eqArr object >‎

maxDist

“0”

objDist

“0”

rSp

“0”

rSpRule

“0” <single>

[Example:

A simple array, , is represented as follows:

<m:eqArr>
<m:e>
<m:r>
<m:t>a=b+c</m:t>
</m:r>
</m:e>
  <m:e>
<m:r>
<m:t>d+e=f</m:t>
</m:r>
</m:e>
</m:eqArr>

A more complex array with alignment points, e.g.:

is represented as follows:

<m:eqArr>
    <m:e>
        <m:r>
            <m:t>&amp;x+&amp;&amp;y+&amp;&amp;z&amp;&amp;= &amp;&amp;10</m:t> 
        </m:r>
    </m:e>
    <m:e>
        <m:r>
            <m:t>3&amp;x+&amp;&amp;y+&amp;2&amp;z&amp;&amp;= &amp;&amp;34</m:t> 
        </m:r>
    </m:e>
    <m:e>
        <m:r>
            <m:t>-5&amp;x+&amp;2&amp;y-&amp;&amp;z&amp;&amp;= &amp;&amp;-14</m:t> 
        </m:r>
    </m:e>
</m:eqArr>

Notice that the variables, operators, and digits of the sums line up properly, as the align values line up between each argument by adding space at the position of each spacer value.

end example]

Parent Elements

deg (§22.1.2.26); del (§17.13.5.14); den (§22.1.2.28); e (§22.1.2.32); fName (§22.1.2.37); ins (§17.13.5.18); lim (§22.1.2.52); moveFrom (§17.13.5.22); moveTo (§17.13.5.25); num (§22.1.2.75); oMath (§22.1.2.77); sub (§22.1.2.112); sup (§22.1.2.114)

Child Elements

Subclause

e (Element (Argument))

§22.1.2.32

eqArrPr (Array Properties)

§22.1.2.35

[Note: The W3C XML Schema definition of this element’s content model (CT_EqArr) is located in §A.6.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

Reference

EquationArray Members

DocumentFormat.OpenXml.Math Namespace