Aspose::Words::CommentRangeEnd Class Referencefinal

Denotes the end of a region of text that has a comment associated with it. More...

#include "Aspose.Words.Cpp/Model/Text/CommentRangeEnd.h"

Inherits Aspose::Words::Node, IDisplaceableByCustomXml, and INodeWithAnnotationId.

Public Member Functions

int32_t get_Id () const
 Specifies the identifier of the comment to which this region is linked to. More...
 
void set_Id (int32_t value)
 Setter for Aspose::Words::CommentRangeEnd::get_Id. More...
 
Aspose::Words::Revisions::DisplacedByType get_DisplacedByCustomXml ()
 
void set_DisplacedByCustomXml (Aspose::Words::Revisions::DisplacedByType value)
 
int32_t get_IdInternal ()
 
void set_IdInternal (int32_t value)
 
int32_t get_ParentIdInternal ()
 
void set_ParentIdInternal (int32_t value)
 
virtual Aspose::Words::NodeType get_NodeType () const
 Returns Aspose::Words::NodeType::CommentRangeEnd. More...
 
 CommentRangeEnd (System::SharedPtr< Aspose::Words::DocumentBase > doc, int32_t id)
 Initializes a new instance of this class. More...
 
virtual bool Accept (System::SharedPtr< Aspose::Words::DocumentVisitor > visitor)
 Accepts a visitor. More...
 
- Public Member Functions inherited from Aspose::Words::Node
System::SharedPtr< Aspose::Words::CompositeNodeget_ParentNode ()
 Gets the immediate parent of this node. More...
 
virtual System::SharedPtr< Aspose::Words::DocumentBaseget_Document ()
 Gets the document to which this node belongs. More...
 
System::SharedPtr< Aspose::Words::Nodeget_PreviousSibling ()
 Gets the node immediately preceding this node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_NextSibling ()
 Gets the node immediately following this node. More...
 
virtual bool get_IsComposite ()
 Returns true if this node can contain other nodes. More...
 
System::SharedPtr< Aspose::Words::Rangeget_Range ()
 Returns a Range object that represents the portion of a document that is contained in this node. More...
 
System::SharedPtr< Aspose::Words::NodeClone (bool isCloneChildren)
 
virtual System::String GetText ()
 Gets the text of this node and of all its children. More...
 
template<typename T >
GetAncestorOf ()
 
System::SharedPtr< Aspose::Words::CompositeNodeGetAncestor (Aspose::Words::NodeType ancestorType)
 Gets the first ancestor of the specified Aspose::Words::NodeType. More...
 
void Remove ()
 Removes itself from the parent. More...
 
System::SharedPtr< Aspose::Words::NodeNextPreOrder (System::SharedPtr< Aspose::Words::Node > rootNode)
 Gets next node according to the pre-order tree traversal algorithm. More...
 
System::SharedPtr< Aspose::Words::NodePreviousPreOrder (System::SharedPtr< Aspose::Words::Node > rootNode)
 Gets the previous node according to the pre-order tree traversal algorithm. More...
 
System::String ToString (Aspose::Words::SaveFormat saveFormat)
 Exports the content of the node into a string in the specified format. More...
 
System::String ToString (System::SharedPtr< Aspose::Words::Saving::SaveOptions > saveOptions)
 Exports the content of the node into a string using the specified save options. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from Aspose::Words::Node
static System::String NodeTypeToString (Aspose::Words::NodeType nodeType)
 A utility method that converts a node type enum value into a user friendly string. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 

Detailed Description

Denotes the end of a region of text that has a comment associated with it.

To create a comment anchored to a region of text, you need to create a Aspose::Words::Comment and then create Aspose::Words::CommentRangeStart and Aspose::Words::CommentRangeEnd and set their identifiers to the same Aspose::Words::Comment::get_Id value.

Aspose::Words::CommentRangeEnd is an inline-level node and can only be a child of Aspose::Words::Paragraph.

See also
Aspose::Words::Comment, Aspose::Words::CommentRangeStart

Constructor & Destructor Documentation

◆ CommentRangeEnd()

Aspose::Words::CommentRangeEnd::CommentRangeEnd ( System::SharedPtr< Aspose::Words::DocumentBase doc,
int32_t  id 
)

Initializes a new instance of this class.

When Aspose::Words::CommentRangeEnd is created, it belongs to the specified document, but is not yet part of the document and Aspose::Words::Node::get_ParentNode is null.

To append a Aspose::Words::CommentRangeEnd to the document use InsertAfter or InsertBefore on the paragraph where you want the comment inserted.

Parameters
docThe owner document.
idThe comment identifier to which this object is linked.

Member Function Documentation

◆ Accept()

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

Accepts a visitor.

Calls Aspose::Words::DocumentVisitor::VisitCommentRangeEnd(System::SharedPtr<Aspose::Words::CommentRangeEnd>).

For more info see the Visitor design pattern.

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

Implements Aspose::Words::Node.

◆ get_DisplacedByCustomXml()

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

◆ get_Id()

int32_t Aspose::Words::CommentRangeEnd::get_Id ( ) const

Specifies the identifier of the comment to which this region is linked to.

◆ get_IdInternal()

int32_t Aspose::Words::CommentRangeEnd::get_IdInternal ( )

◆ get_NodeType()

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

◆ get_ParentIdInternal()

int32_t Aspose::Words::CommentRangeEnd::get_ParentIdInternal ( )

◆ set_DisplacedByCustomXml()

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

◆ set_Id()

void Aspose::Words::CommentRangeEnd::set_Id ( int32_t  value)

◆ set_IdInternal()

void Aspose::Words::CommentRangeEnd::set_IdInternal ( int32_t  value)

◆ set_ParentIdInternal()

void Aspose::Words::CommentRangeEnd::set_ParentIdInternal ( int32_t  value)