com.aspose.words

Class BookmarkEnd

java.lang.Object

com.aspose.words.Node

com.aspose.words.BookmarkEnd

All Implemented Interfaces:

java.lang.Cloneable

public class BookmarkEnd
extends Node

Represents an end of a bookmark in a Word document.

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

A complete bookmark in a Word document consists of a BookmarkStart and a matching BookmarkEnd with the same bookmark name.

BookmarkStart and BookmarkEnd are just markers inside a document that specify where the bookmark starts and ends.

Use the Bookmark class as a "facade" to work with a bookmark as a single object.

Constructor Summary

Constructors

Constructor and Description
BookmarkEnd(DocumentBase doc, java.lang.String name) Initializes a new instance of the BookmarkEnd class.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
int	getDisplacedByCustomXml()
java.lang.String	getName() Gets the bookmark name.
int	getNodeType() Returns NodeType.BOOKMARK_END.
void	setDisplacedByCustomXml(int value)
void	setName(java.lang.String value) Sets the bookmark name.

Methods inherited from class com.aspose.words.Node

dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, getText, isComposite, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object

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

Constructor Detail

BookmarkEnd

public BookmarkEnd(DocumentBase doc,
                   java.lang.String name)

Initializes a new instance of the BookmarkEnd class.

Parameters:

doc - The owner document.

name - The name of the bookmark. Cannot be null.

Method Detail

getNodeType

public int getNodeType()

Returns NodeType.BOOKMARK_END.

Specified by:

getNodeType in class Node

Returns:

NodeType.BOOKMARK_END. The returned value is one of NodeType constants.

getDisplacedByCustomXml

public int getDisplacedByCustomXml()

setDisplacedByCustomXml

public void setDisplacedByCustomXml(int value)

accept

public boolean accept(DocumentVisitor visitor)
               throws java.lang.Exception

Accepts a visitor.

Calls DocumentVisitor.visitBookmarkEnd(com.aspose.words.BookmarkEnd).

For more info see the Visitor design pattern.

Specified by:

accept in class Node

Parameters:

visitor - The visitor that will visit the node.

Returns:

False if the visitor requested the enumeration to stop.

Throws:

java.lang.Exception

getName

public java.lang.String getName()

Gets the bookmark name.

Cannot be null.

Returns:

The bookmark name.

setName

public void setName(java.lang.String value)

Sets the bookmark name.

Cannot be null.

Parameters:

value - The bookmark name.