com.aspose.words

Class Bookmark

java.lang.Object

com.aspose.words.Bookmark

public class Bookmark
extends java.lang.Object

Represents a single bookmark.

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

Bookmark is a "facade" object that encapsulates two nodes getBookmarkStart() and getBookmarkEnd() in a document tree and allows to work with a bookmark as a single object.

Method Summary

Modifier and Type	Method and Description
BookmarkEnd	getBookmarkEnd() Gets the node that represents the end of the bookmark.
BookmarkStart	getBookmarkStart() Gets the node that represents the start of the bookmark.
int	getFirstColumn() Gets the zero-based index of the first column of the table column range associated with the bookmark.
int	getLastColumn() Gets the zero-based index of the last column of the table column range associated with the bookmark.
java.lang.String	getName() Gets the name of the bookmark.
java.lang.String	getText() Gets the text enclosed in the bookmark.
boolean	isColumn() Returns true if this bookmark is a table column bookmark.
void	remove() Removes the bookmark from the document.
void	setName(java.lang.String value) Sets the name of the bookmark.
void	setText(java.lang.String value) Sets the text enclosed in the bookmark.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Gets the name of the bookmark. Note that if you change the name of a bookmark to a name that already exists in the document, no error will be given and only the first bookmark will be stored when you save the document.

Returns:

The name of the bookmark.

setName

public void setName(java.lang.String value)
             throws java.lang.Exception

Sets the name of the bookmark. Note that if you change the name of a bookmark to a name that already exists in the document, no error will be given and only the first bookmark will be stored when you save the document.

Parameters:

value - The name of the bookmark.

Throws:

java.lang.Exception

getText

public java.lang.String getText()
                         throws java.lang.Exception

Gets the text enclosed in the bookmark.

Returns:

The text enclosed in the bookmark.

Throws:

java.lang.Exception

setText

public void setText(java.lang.String value)
             throws java.lang.Exception

Sets the text enclosed in the bookmark.

Parameters:

value - The text enclosed in the bookmark.

Throws:

java.lang.Exception

getBookmarkStart

public BookmarkStart getBookmarkStart()

Gets the node that represents the start of the bookmark.

Returns:

The node that represents the start of the bookmark.

getBookmarkEnd

public BookmarkEnd getBookmarkEnd()
                           throws java.lang.Exception

Gets the node that represents the end of the bookmark.

Returns:

The node that represents the end of the bookmark.

Throws:

java.lang.Exception

isColumn

public boolean isColumn()

Returns true if this bookmark is a table column bookmark.

Returns:

true if this bookmark is a table column bookmark.

getFirstColumn

public int getFirstColumn()

Gets the zero-based index of the first column of the table column range associated with the bookmark. Returns -1 if this bookmark is not a table column bookmark.

Returns:

The zero-based index of the first column of the table column range associated with the bookmark.

getLastColumn

public int getLastColumn()

Gets the zero-based index of the last column of the table column range associated with the bookmark. Returns -1 if this bookmark is not a table column bookmark.

Returns:

The zero-based index of the last column of the table column range associated with the bookmark.

remove

public void remove()
            throws java.lang.Exception

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

Throws:

java.lang.Exception