remove method
remove(field)
Removes the specified field from this collection and from the document.
def remove(self, field: aspose.words.fields.Field):
...
Parameter | Type | Description |
---|---|---|
field | Field | A field to remove. |
Examples
Shows how to remove fields from a field collection.
doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.insert_field(field_code=' DATE \\@ "dddd, d MMMM yyyy" ')
builder.insert_field(field_code=' TIME ')
builder.insert_field(field_code=' REVNUM ')
builder.insert_field(field_code=' AUTHOR "John Doe" ')
builder.insert_field(field_code=' SUBJECT "My Subject" ')
builder.insert_field(field_code=' QUOTE "Hello world!" ')
doc.update_fields()
fields = doc.range.fields
self.assertEqual(6, fields.count)
# Below are four ways of removing fields from a field collection.
# 1 - Get a field to remove itself:
fields[0].remove()
self.assertEqual(5, fields.count)
# 2 - Get the collection to remove a field that we pass to its removal method:
last_field = fields[3]
fields.remove(last_field)
self.assertEqual(4, fields.count)
# 3 - Remove a field from a collection at an index:
fields.remove_at(2)
self.assertEqual(3, fields.count)
# 4 - Remove all the fields from the collection at once:
fields.clear()
self.assertEqual(0, fields.count)
See Also
- module aspose.words.fields
- class FieldCollection