ASPOSE home

com.aspose.words
Class Bookmark

java.lang.Object
    extended by com.aspose.words.Bookmark

public class Bookmark
extends java.lang.Object

Represents a single bookmark.

Bookmark is a "facade" object that encapsulates two nodes BookmarkStart and BookmarkEnd in a document tree and allows to work with a bookmark as a single object.


Property Getters/Setters Summary
BookmarkEndgetBookmarkEnd()
           Gets the node that represents the end of the bookmark.
BookmarkStartgetBookmarkStart()
           Gets the node that represents the start of the bookmark.
java.lang.StringgetName()
voidsetName(java.lang.String value)
           Gets the name of the bookmark.
java.lang.StringgetText()
voidsetText(java.lang.String value)
           Gets/sets the text enclosed in the bookmark.
 
Method Summary
voidremove()
           Removes the bookmark from the document. Does not remove text inside the bookmark.
 

Property Getters/Setters Detail

getName/setName

public java.lang.String getName()

public void setName(java.lang.String value)
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.

getText/setText

public java.lang.String getText()

public void setText(java.lang.String value)
Gets/sets the text enclosed in the bookmark.

getBookmarkStart

public BookmarkStart getBookmarkStart()
Gets the node that represents the start of the bookmark.

getBookmarkEnd

public BookmarkEnd getBookmarkEnd()
Gets the node that represents the end of the bookmark.

Method Detail

remove

public void remove()
           throws java.lang.Exception
Removes the bookmark from the document. Does not remove text inside the bookmark.

See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home