BookmarkStart

Overview

BookmarkStart is a class in Aspose.Words FOSS for Java. Inherits from: Node, IBookmarkNode, IDisplaceableByCustomXml.

Represents a start of a bookmark in a Word document.

Edition status of its 33 listed members (a property and its accessor methods are listed separately, overloads once): 33 not yet exercised by a verified example.

This class declares 25 methods for BookmarkStart objects in Java programs. Available methods include: BookmarkStart, accept, deepClone, getAncestor, getBookmark, getCustomNodeId, getDocument, getName, getNextSibling, getNodeType, getParentNode, getPreviousSibling, and 10 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: bookmark, composite, customNodeId, document, name, nextSibling, and 5 more.

Properties

NameTypeAccessDescription
nodeTypeintReadReturns BookmarkStart.
bookmarkBookmarkReadGets the facade object that encapsulates this bookmark start and end.
textStringReadReturns an empty string.
nameStringRead/WriteGets or sets the bookmark name.
parentNodeCompositeNodeReadGets the immediate parent of this node.
documentDocumentBaseReadGets the document to which this node belongs.
previousSiblingNodeReadGets the node immediately preceding this node.
nextSiblingNodeReadGets the node immediately following this node.
compositebooleanReadReturns true if this node can contain other nodes.
rangeRangeReadReturns a Range object that represents the portion of a document that is contained in this node.
customNodeIdintRead/WriteSpecifies custom node identifier.

Methods

SignatureDescription
BookmarkStart(doc: DocumentBase, name: String)Initializes a new instance of the BookmarkStart class.
getNodeType() → intReturns BookmarkStart.
getBookmark() → BookmarkGets the facade object that encapsulates this bookmark start and end.
accept(visitor: DocumentVisitor) → booleanAccepts a visitor.
getText() → StringReturns an empty string.
getName() → StringGets or sets the bookmark name.
setName(value: String)Sets the name value.
getParentNode() → CompositeNodeGets the immediate parent of this node.
getDocument() → DocumentBaseGets the document to which this node belongs.
getPreviousSibling() → NodeGets the node immediately preceding this node.
getNextSibling() → NodeGets the node immediately following this node.
isComposite() → booleanReturns true if this node can contain other nodes.
getRange() → RangeReturns a Range object that represents the portion of a document that is contained in this node.
deepClone(isCloneChildren: boolean) → NodeCalls deepClone(isCloneChildren) on this BookmarkStart instance.
getAncestor(ancestorType: Class) → CompositeNodeGets the first ancestor of the specified object type.
getAncestor(ancestorType: int) → CompositeNodeGets the first ancestor of the specified NodeType.
remove()Removes itself from the parent.
nextPreOrder(rootNode: Node) → NodeGets next node according to the pre-order tree traversal algorithm.
previousPreOrder(rootNode: Node) → NodeGets the previous node according to the pre-order tree traversal algorithm.
toString(saveFormat: int) → StringExports the content of the node into a string in the specified format.
toString(saveOptions: SaveOptions) → StringExports the content of the node into a string using the specified save options.
nodeTypeToString(nodeType: int) → StringA utility method that converts a node type enum value into a user friendly string.
getCustomNodeId() → intSpecifies custom node identifier.
setCustomNodeId(value: int)Sets the custom node id value.
toString() → StringCalls toString on this BookmarkStart instance.

See Also