remove method

remove()

Removes the bookmark from the document. Does not remove text inside the bookmark.

def remove(self):
    ...

Examples

Shows how to remove bookmarks from a document.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)
# Insert five bookmarks with text inside their boundaries.
for i in range(1, 6):
    bookmark_name = f'MyBookmark_{i}'
    builder.start_bookmark(bookmark_name)
    builder.write(f'Text inside {bookmark_name}.')
    builder.end_bookmark(bookmark_name)
    builder.insert_break(aw.BreakType.PARAGRAPH_BREAK)
# This collection stores bookmarks.
bookmarks = doc.range.bookmarks
self.assertEqual(5, bookmarks.count)
# There are several ways of removing bookmarks.
# 1 -  Calling the bookmark's "remove" method:
bookmarks.get_by_name('MyBookmark_1').remove()
self.assertFalse(any((b for b in bookmarks if b.name == 'MyBookmark_1')))
# 2 -  Passing the bookmark to the collection's "remove" method:
bookmark = doc.range.bookmarks[0]
doc.range.bookmarks.remove(bookmark)
self.assertFalse(any((b for b in bookmarks if b.name == 'MyBookmark_2')))
# 3 -  Removing a bookmark from the collection by name:
doc.range.bookmarks.remove('MyBookmark_3')
self.assertFalse(any((b for b in bookmarks if b.name == 'MyBookmark_3')))
# 4 -  Removing a bookmark at an index in the bookmark collection:
doc.range.bookmarks.remove_at(0)
self.assertFalse(any((b for b in bookmarks if b.name == 'MyBookmark_4')))
# We can clear the entire bookmark collection.
bookmarks.clear()
# The text that was inside the bookmarks is still present in the document.
self.assertListEqual([], list(bookmarks))
self.assertEqual('Text inside MyBookmark_1.\r' + 'Text inside MyBookmark_2.\r' + 'Text inside MyBookmark_3.\r' + 'Text inside MyBookmark_4.\r' + 'Text inside MyBookmark_5.', doc.get_text().strip())

See Also

Bookmark.text property