FieldQuote class

FieldQuote class

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

Remarks

Retrieves the specified text.

Inheritance: FieldQuoteField

Constructors

NameDescription
FieldQuote()The default constructor.

Properties

NameDescription
display_resultGets the text that represents the displayed field result.
(Inherited from Field)
endGets the node that represents the field end.
(Inherited from Field)
formatGets a FieldFormat object that provides typed access to field’s formatting.
(Inherited from Field)
is_dirtyGets 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_lockedGets or sets whether the field is locked (should not recalculate its result).
(Inherited from Field)
locale_idGets or sets the LCID of the field.
(Inherited from Field)
resultGets or sets text that is between the field separator and field end.
(Inherited from Field)
separatorGets the node that represents the field separator. Can be None.
(Inherited from Field)
startGets the node that represents the start of the field.
(Inherited from Field)
textGets or sets the text to retrieve.
typeGets the Microsoft Word field type.
(Inherited from Field)

Methods

NameDescription
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 to use the QUOTE field.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

# Insert a QUOTE field, which will display the value of its Text property.
field = builder.insert_field(aw.fields.FieldType.FIELD_QUOTE, True).as_field_quote()
field.text = "\"Quoted text\""

self.assertEqual(" QUOTE  \"\\\"Quoted text\\\"\"", field.get_field_code())

# Insert a QUOTE field and nest a DATE field inside it.
# DATE fields update their value to the current date every time we open the document using Microsoft Word.
# Nesting the DATE field inside the QUOTE field like this will freeze its value
# to the date when we created the document.
builder.write("\nDocument creation date: ")
field = builder.insert_field(aw.fields.FieldType.FIELD_QUOTE, True).as_field_quote()
builder.move_to(field.separator)
builder.insert_field(aw.fields.FieldType.FIELD_DATE, True)

today = datetime.now().strftime("%d/%m/%Y").lstrip('0')

self.assertEqual(" QUOTE \u0013 DATE \u0014" + today + "\u0015", field.get_field_code())

# Update all the fields to display their correct results.
doc.update_fields()

self.assertEqual("\"Quoted text\"", doc.range.fields[0].result)

doc.save(ARTIFACTS_DIR + "Field.field_quote.docx")

See Also