Aspose::Words::BookmarkStart class
Contents
[
Hide
]BookmarkStart class
Represents a start of a bookmark in a Word document. To learn more, visit the Working with Bookmarks documentation article.
class BookmarkStart : public Aspose::Words::Node,
public Aspose::Words::IBookmarkNode,
public Aspose::Words::IDisplaceableByCustomXml
Methods
| Method | Description |
|---|---|
| Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) override | Accepts a visitor. |
| BookmarkStart(const System::SharedPtr<Aspose::Words::DocumentBase>&, const System::String&) | Initializes a new instance of the BookmarkStart class. |
| Clone(bool) | Creates a duplicate of the node. |
| get_Bookmark() | Gets the facade object that encapsulates this bookmark start and end. |
| get_CustomNodeId() const | Specifies custom node identifier. |
| virtual get_Document() const | Gets the document to which this node belongs. |
| virtual get_IsComposite() | Returns true if this node can contain other nodes. |
| get_Name() override | Gets the bookmark name. |
| get_NextNode() const | |
| get_NextSibling() | Gets the node immediately following this node. |
| get_NodeType() const override | Returns BookmarkStart. |
| get_ParentNode() | Gets the immediate parent of this node. |
| get_PreviousSibling() | Gets the node immediately preceding this node. |
| get_PrevNode() const | |
| get_Range() | Returns a Range object that represents the portion of a document that is contained in this node. |
| GetAncestor(Aspose::Words::NodeType) | Gets the first ancestor of the specified NodeType. |
| GetAncestorOf() | |
| GetText() override | Returns an empty string. |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| IsAncestorNode(const System::SharedPtr<Aspose::Words::Node>&) | |
| NextPreOrder(const System::SharedPtr<Aspose::Words::Node>&) | Gets next node according to the pre-order tree traversal algorithm. |
| static NodeTypeToString(Aspose::Words::NodeType) | A utility method that converts a node type enum value into a user friendly string. |
| PreviousPreOrder(const System::SharedPtr<Aspose::Words::Node>&) | Gets the previous node according to the pre-order tree traversal algorithm. |
| Remove() | Removes itself from the parent. |
| set_CustomNodeId(int32_t) | Setter for Aspose::Words::Node::get_CustomNodeId. |
| set_Name(System::String) override | Sets the bookmark name. |
| set_NextNode(const System::SharedPtr<Aspose::Words::Node>&) | |
| set_PrevNode(const System::SharedPtr<Aspose::Words::Node>&) | |
| SetParent(const System::SharedPtr<Aspose::Words::Node>&) | |
| ToString(Aspose::Words::SaveFormat) | Exports the content of the node into a string in the specified format. |
| ToString(const System::SharedPtr<Aspose::Words::Saving::SaveOptions>&) | Exports the content of the node into a string using the specified save options. |
| static Type() |
Remarks
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.
See Also
- Class Node
- Namespace Aspose::Words
- Library Aspose.Words for C++