Aspose::Words::BookmarkStart Class Reference

Detailed Description

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.

#include <Aspose.Words.Cpp/Model/Bookmarks/BookmarkStart.h>

+ Inheritance diagram for Aspose::Words::BookmarkStart:

Public Member Functions

 BookmarkStart (SharedPtr< DocumentBase > doc, String name)
 Initializes a new instance of the BookmarkStart class. More...
virtual bool Accept (SharedPtr< DocumentVisitor > visitor)
 Accepts a visitor. More...
SharedPtr< Bookmarkget_Bookmark ()
 Gets the facade object that encapsulates this bookmark start and end. More...
Aspose::Words::Revisions::DisplacedByType get_DisplacedByCustomXml ()
String get_Name ()
 Gets or sets the bookmark name. More...
virtual NodeType get_NodeType () const
 Returns BookmarkStart. More...
virtual String GetText ()
 Returns an empty string. More...
void set_DisplacedByCustomXml (Aspose::Words::Revisions::DisplacedByType value)
void set_Name (String value)
 Setter for get_Name. More...
- Public Member Functions inherited from Node
SharedPtr< NodeClone (bool isCloneChildren)
virtual SharedPtr< DocumentBaseget_Document ()
 Gets the document to which this node belongs. More...
virtual bool get_IsComposite ()
 Returns true if this node can contain other nodes. More...
SharedPtr< Nodeget_NextSibling ()
 Gets the node immediately following this node. More...
SharedPtr< CompositeNodeget_ParentNode ()
 Gets the immediate parent of this node. More...
SharedPtr< Nodeget_PreviousSibling ()
 Gets the node immediately preceding this node. More...
SharedPtr< Rangeget_Range ()
 Returns a Range object that represents the portion of a document that is contained in this node. More...
SharedPtr< CompositeNodeGetAncestor (NodeType ancestorType)
 Gets the first ancestor of the specified NodeType. More...
template<typename T >
GetAncestorOf ()
SharedPtr< NodeNextPreOrder (SharedPtr< Node > rootNode)
 Gets next node according to the pre-order tree traversal algorithm. More...
SharedPtr< NodePreviousPreOrder (SharedPtr< Node > rootNode)
 Gets the previous node according to the pre-order tree traversal algorithm. More...
void Remove ()
 Removes itself from the parent. 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...
- Public Member Functions inherited from Object
ASPOSECPP_SHARED_API Object (Object const &x)
virtual ASPOSECPP_SHARED_API ~Object ()
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
Detail::SmartPtrCounter * GetCounter ()
virtual ASPOSECPP_SHARED_API int GetHashCode () const
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
Objectoperator= (Object const &x)
bool ReferenceEquals (String const &str, std::nullptr_t)
bool ReferenceEquals (String const &str1, String const &str2)
int RemovedSharedRefs (int count)
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
int SharedCount () const
ObjectSharedRefAdded ()
int SharedRefRemovedSafe ()
virtual ASPOSECPP_SHARED_API String ToString () const
Detail::SmartPtrCounter * WeakRefAdded ()
void WeakRefRemoved ()

Additional Inherited Members

- Public Types inherited from Object
typedef SmartPtr< Objectptr
typedef System::Details::SharedMembersType shared_members_type
- Static Public Member Functions inherited from Node
static String NodeTypeToString (NodeType nodeType)
 A utility method that converts a node type enum value into a user friendly string. More...
- Static Public Member Functions inherited from Object
bool Equals (double const &objA, double const &objB)
bool Equals (float const &objA, float const &objB)
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
static const TypeInfoType ()

Constructor & Destructor Documentation

◆ BookmarkStart()

Aspose::Words::BookmarkStart::BookmarkStart ( System::SharedPtr< Aspose::Words::DocumentBase doc,
System::String  name 

Initializes a new instance of the BookmarkStart class.

docThe owner document.
nameThe name of the bookmark. Cannot be null.

Member Function Documentation

◆ Accept()

virtual bool Aspose::Words::BookmarkStart::Accept ( System::SharedPtr< Aspose::Words::DocumentVisitor visitor)

Accepts a visitor.

Calls VisitBookmarkStart.

For more info see the Visitor design pattern.

visitorThe visitor that will visit the node.
False if the visitor requested the enumeration to stop.

Implements Aspose::Words::Node.

◆ get_Bookmark()

System::SharedPtr<Aspose::Words::Bookmark> Aspose::Words::BookmarkStart::get_Bookmark ( )

Gets the facade object that encapsulates this bookmark start and end.

◆ get_DisplacedByCustomXml()

Aspose::Words::Revisions::DisplacedByType Aspose::Words::BookmarkStart::get_DisplacedByCustomXml ( )

◆ get_Name()

System::String Aspose::Words::BookmarkStart::get_Name ( )

Gets or sets the bookmark name.

Cannot be null.

◆ get_NodeType()

virtual Aspose::Words::NodeType Aspose::Words::BookmarkStart::get_NodeType ( ) const

Returns BookmarkStart.

Implements Aspose::Words::Node.

◆ GetText()

virtual System::String Aspose::Words::BookmarkStart::GetText ( )

Returns an empty string.

An empty string.

Reimplemented from Aspose::Words::Node.

◆ set_DisplacedByCustomXml()

void Aspose::Words::BookmarkStart::set_DisplacedByCustomXml ( Aspose::Words::Revisions::DisplacedByType  value)

◆ set_Name()

void Aspose::Words::BookmarkStart::set_Name ( System::String  value)