Represents a start of a bookmark in a Word document.
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.
Shows how to add bookmarks and update their contents.
#include <Aspose.Words.Cpp/BookmarkStart.h>
Public Member Functions | |
BookmarkStart (SharedPtr< DocumentBase > doc, String name) | |
Initializes a new instance of the BookmarkStart class. More... | |
bool | Accept (SharedPtr< DocumentVisitor > visitor) override |
Accepts a visitor. More... | |
SharedPtr< Bookmark > | get_Bookmark () |
Gets the facade object that encapsulates this bookmark start and end. More... | |
Aspose::Words::Revisions::DisplacedByType | get_DisplacedByCustomXml () override |
String | get_Name () override |
Gets or sets the bookmark name. More... | |
NodeType | get_NodeType () const override |
Returns BookmarkStart. More... | |
String | GetText () override |
Returns an empty string. More... | |
virtual const TypeInfo & | GetType () const override |
virtual bool | Is (const TypeInfo &target) const override |
void | set_DisplacedByCustomXml (Aspose::Words::Revisions::DisplacedByType value) override |
void | set_Name (String value) override |
Setter for get_Name. More... | |
![]() | |
SharedPtr< Node > | Clone (bool isCloneChildren) |
Creates a duplicate of the node. More... | |
int32_t | get_CustomNodeId () const |
Specifies custom node identifier. More... | |
virtual SharedPtr< DocumentBase > | get_Document () const |
Gets the document to which this node belongs. More... | |
virtual bool | get_IsComposite () |
Returns true if this node can contain other nodes. More... | |
SharedPtr< Node > | get_NextSibling () |
Gets the node immediately following this node. More... | |
SharedPtr< CompositeNode > | get_ParentNode () |
Gets the immediate parent of this node. More... | |
SharedPtr< Node > | get_PreviousSibling () |
Gets the node immediately preceding this node. More... | |
SharedPtr< Range > | get_Range () |
Returns a Range object that represents the portion of a document that is contained in this node. More... | |
SharedPtr< CompositeNode > | GetAncestor (NodeType ancestorType) |
Gets the first ancestor of the specified NodeType. More... | |
template<typename T > | |
T | GetAncestorOf () |
SharedPtr< Node > | NextPreOrder (SharedPtr< Node > rootNode) |
Gets next node according to the pre-order tree traversal algorithm. More... | |
SharedPtr< Node > | PreviousPreOrder (SharedPtr< Node > rootNode) |
Gets the previous node according to the pre-order tree traversal algorithm. More... | |
void | Remove () |
Removes itself from the parent. More... | |
void | set_CustomNodeId (int32_t value) |
Setter for get_CustomNodeId. More... | |
String | ToString (SaveFormat saveFormat) |
Exports the content of the node into a string in the specified format. More... | |
String | ToString (SharedPtr< SaveOptions > saveOptions) |
Exports the content of the node into a string using the specified save options. More... | |
Static Public Member Functions | |
static const TypeInfo & | Type () |
![]() | |
static String | NodeTypeToString (NodeType nodeType) |
A utility method that converts a node type enum value into a user friendly string. More... | |
static const TypeInfo & | Type () |
Aspose::Words::BookmarkStart::BookmarkStart | ( | System::SharedPtr< Aspose::Words::DocumentBase > | doc, |
System::String | name | ||
) |
Initializes a new instance of the BookmarkStart class.
doc | The owner document. |
name | The name of the bookmark. Cannot be null. |
Shows how to add bookmarks and update their contents.
|
overridevirtual |
Accepts a visitor.
Calls VisitBookmarkStart().
For more info see the Visitor design pattern.
visitor | The visitor that will visit the node. |
Shows how to add bookmarks and update their contents.
Implements Aspose::Words::Node.
System::SharedPtr<Aspose::Words::Bookmark> Aspose::Words::BookmarkStart::get_Bookmark | ( | ) |
Gets the facade object that encapsulates this bookmark start and end.
Shows how to add bookmarks and update their contents.
|
override |
|
override |
Gets or sets the bookmark name.
Cannot be null.
Shows how to add bookmarks and update their contents.
|
overridevirtual |
Returns BookmarkStart.
Shows how to traverse a composite node's tree of child nodes.
Implements Aspose::Words::Node.
|
overridevirtual |
Returns an empty string.
Shows how to add bookmarks and update their contents.
Reimplemented from Aspose::Words::Node.
|
overridevirtual |
Reimplemented from Aspose::Words::Node.
|
overridevirtual |
Reimplemented from Aspose::Words::Node.
|
override |
|
override |
Setter for Aspose::Words::BookmarkStart::get_Name.
|
static |