com.aspose.words

Class BookmarkCollection

java.lang.Object

com.aspose.words.BookmarkCollection

All Implemented Interfaces:

java.lang.Iterable

public class BookmarkCollection
extends java.lang.Object
implements java.lang.Iterable

A collection of Bookmark objects that represent the bookmarks in the specified range.

To learn more, visit the Working with Bookmarks documentation article.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all bookmarks from this collection and from the document.
Bookmark	get(int index) Returns a bookmark at the specified index.
Bookmark	get(java.lang.String bookmarkName) Returns a bookmark by name.
int	getCount() Returns the number of bookmarks in the collection.
java.util.Iterator	iterator() Returns an enumerator object.
void	remove(Bookmark bookmark) Removes the specified bookmark from the document.
void	remove(java.lang.String bookmarkName) Removes a bookmark with the specified name.
void	removeAt(int index) Removes a bookmark at the specified index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getCount

public int getCount()

Returns the number of bookmarks in the collection.

Returns:

The number of bookmarks in the collection.

get

public Bookmark get(int index)

Returns a bookmark at the specified index.

The index is zero-based.

Negative indexes are allowed and indicate access from the back of the collection. For example -1 means the last item, -2 means the second before last and so on.

If index is greater than or equal to the number of items in the list, this returns a null reference.

If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.

Parameters:

index - An index into the collection.

Returns:

A bookmark at the specified index.

get

public Bookmark get(java.lang.String bookmarkName)

Returns a bookmark by name.

Returns null if the bookmark with the specified name cannot be found.

Parameters:

bookmarkName - Case-insensitive name of the bookmark.

Returns:

A bookmark by name.

remove

public void remove(Bookmark bookmark)
            throws java.lang.Exception

Removes the specified bookmark from the document.

Parameters:

bookmark - The bookmark to remove.

Throws:

java.lang.Exception

remove

public void remove(java.lang.String bookmarkName)
            throws java.lang.Exception

Removes a bookmark with the specified name.

Parameters:

bookmarkName - The case-insensitive name of the bookmark to remove.

Throws:

java.lang.Exception

removeAt

public void removeAt(int index)
              throws java.lang.Exception

Removes a bookmark at the specified index.

Parameters:

index - The zero-based index of the bookmark to remove.

Throws:

java.lang.Exception

clear

public void clear()
           throws java.lang.Exception

Removes all bookmarks from this collection and from the document.

Throws:

java.lang.Exception

iterator

public java.util.Iterator iterator()

Returns an enumerator object.

Specified by:

iterator in interface java.lang.Iterable