FieldEQ class

Implements the EQ field. To learn more, visit the Working with Fields documentation article.

Inheritance: FieldEQ → Field

Constructors

Name	Description
FieldEQ()	The default constructor.

Properties

Name	Description
display_result	Gets the text that represents the displayed field result. (Inherited from Field)
end	Gets the node that represents the field end. (Inherited from Field)
format	Gets a FieldFormat object that provides typed access to field’s formatting. (Inherited from Field)
is_dirty	Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. (Inherited from Field)
is_locked	Gets or sets whether the field is locked (should not recalculate its result). (Inherited from Field)
locale_id	Gets or sets the LCID of the field. (Inherited from Field)
result	Gets or sets text that is between the field separator and field end. (Inherited from Field)
separator	Gets the node that represents the field separator. Can be `None`. (Inherited from Field)
start	Gets the node that represents the start of the field. (Inherited from Field)
type	Gets the Microsoft Word field type. (Inherited from Field)

Methods

Name	Description
as_office_math()	Returns Office Math object corresponded to the EQ field.
get_field_code()	Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. (Inherited from Field)
get_field_code(include_child_field_codes)	Returns text between field start and field separator (or field end if there is no separator). (Inherited from Field)
remove()	Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns `None`. (Inherited from Field)
unlink()	Performs the field unlink. (Inherited from Field)
update()	Performs the field update. Throws if the field is being updated already. (Inherited from Field)
update(ignore_merge_format)	Performs a field update. Throws if the field is being updated already. (Inherited from Field)

Examples

Shows how to use the EQ field to display a variety of mathematical equations.

def field_eq():
    doc = aw.Document()
    builder = aw.DocumentBuilder(doc)
    # An EQ field displays a mathematical equation consisting of one or many elements.
    # Each element takes the following form: [switch][options][arguments].
    # There may be one switch, and several possible options.
    # The arguments are a set of coma-separated values enclosed by round braces.
    # Here we use a document builder to insert an EQ field, with an "\f" switch, which corresponds to "Fraction".
    # We will pass values 1 and 4 as arguments, and we will not use any options.
    # This field will display a fraction with 1 as the numerator and 4 as the denominator.
    field = insert_field_eq(builder, '\\f(1,4)')
    self.assertEqual(' EQ \\f(1,4)', field.get_field_code())
    # One EQ field may contain multiple elements placed sequentially.
    # We can also nest elements inside one another by placing the inner elements
    # inside the argument brackets of outer elements.
    # We can find the full list of switches, along with their uses here:
    # https://blogs.msdn.microsoft.com/murrays/2018/01/23/microsoft-word-eq-field/
    # Below are applications of nine different EQ field switches that we can use to create different kinds of objects.
    # 1 -  Array switch "\a", aligned left, 2 columns, 3 points of horizontal and vertical spacing:
    insert_field_eq(builder, '\\a \\al \\co2 \\vs3 \\hs3(4x,- 4y,-4x,+ y)')
    # 2 -  Bracket switch "\b", bracket character "[", to enclose the contents in a set of square braces:
    # Note that we are nesting an array inside the brackets, which will altogether look like a matrix in the output.
    insert_field_eq(builder, '\\b \\bc\\[ (\\a \\al \\co3 \\vs3 \\hs3(1,0,0,0,1,0,0,0,1))')
    # 3 -  Displacement switch "\d", displacing text "B" 30 spaces to the right of "A", displaying the gap as an underline:
    insert_field_eq(builder, 'A \\d \\fo30 \\li() B')
    # 4 -  Formula consisting of multiple fractions:
    insert_field_eq(builder, '\\f(d,dx)(u + v) = \\f(du,dx) + \\f(dv,dx)')
    # 5 -  Integral switch "\i", with a summation symbol:
    insert_field_eq(builder, '\\i \\su(n=1,5,n)')
    # 6 -  List switch "\l":
    insert_field_eq(builder, '\\l(1,1,2,3,n,8,13)')
    # 7 -  Radical switch "\r", displaying a cubed root of x:
    insert_field_eq(builder, '\\r (3,x)')
    # 8 -  Subscript/superscript switch "/s", first as a superscript and then as a subscript:
    insert_field_eq(builder, '\\s \\up8(Superscript) Text \\s \\do8(Subscript)')
    # 9 -  Box switch "\x", with lines at the top, bottom, left and right of the input:
    insert_field_eq(builder, '\\x \\to \\bo \\le \\ri(5)')
    # Some more complex combinations.
    insert_field_eq(builder, '\\a \\ac \\vs1 \\co1(lim,n→∞) \\b (\\f(n,n2 + 12) + \\f(n,n2 + 22) + ... + \\f(n,n2 + n2))')
    insert_field_eq(builder, '\\i (,,  \\b(\\f(x,x2 + 3x + 2))) \\s \\up10(2)')
    insert_field_eq(builder, '\\i \\in( tan x, \\s \\up2(sec x), \\b(\\r(3) )\\s \\up4(t) \\s \\up7(2)  dt)')
    doc.save(ARTIFACTS_DIR + 'Field.field_eq.docx')

def insert_field_eq(builder: aw.DocumentBuilder, args: str) -> aw.fields.FieldEQ:
    """Use a document builder to insert an EQ field, set its arguments and start a new paragraph."""
    field = builder.insert_field(aw.fields.FieldType.FIELD_EQUATION, True).as_field_eq()
    builder.move_to(field.separator)
    builder.write(args)
    builder.move_to(field.start.parent_node)
    builder.insert_paragraph()
    return field

Shows how to replace the EQ field with Office Math.

doc = aw.Document(MY_DIR + 'Field sample - EQ.docx')
import aspose.words.fields as awf
field_eq = None
for field in doc.range.fields:
    if field.type == awf.FieldType.FIELD_EQUATION:
        field_eq = field.as_field_eq()
        break
officeMath = field_eq.as_office_math()
field_eq.start.parent_node.insert_before(officeMath, field_eq.start)
field_eq.remove()
doc.save(ARTIFACTS_DIR + 'Field.EQAsOfficeMath.docx')

FieldEQ class

FieldEQ class

Constructors

Properties

Methods

Examples

See Also