ignore_field_codes property

FindReplaceOptions.ignore_field_codes property

Gets or sets a boolean value indicating either to ignore text inside field codes. The default value is False.

@property
def ignore_field_codes(self) -> bool:
    ...

@ignore_field_codes.setter
def ignore_field_codes(self, value: bool):
    ...

Remarks

This option affects only field codes (it does not ignore nodes between NodeType.FIELD_SEPARATOR and NodeType.FIELD_END).

To ignore whole field, please use corresponding option FindReplaceOptions.ignore_fields.

Examples

Shows how to ignore text inside field codes.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)
builder.insert_field('INCLUDETEXT', 'Test IT!')
options = aw.replacing.FindReplaceOptions()
options.ignore_field_codes = ignore_field_codes
# Replace 'T' in document ignoring text inside field code or not.
doc.range.replace_regex('T', '*', options)
print(doc.get_text())
if ignore_field_codes:
    self.assertEqual('\x13INCLUDETEXT\x14*est I*!\x15', doc.get_text().strip())
else:
    self.assertEqual('\x13INCLUDE*EX*\x14*est I*!\x15', doc.get_text().strip())

See Also

FindReplaceOptions.ignore_deleted property FindReplaceOptions.ignore_fields property