Aspose::Words::Replacing::ReplacingArgs Class Reference

Provides data for a custom replace operation. More...

#include "Model/FindReplace/ReplacingArgs.h"

Inherits System::Object.

Public Member Functions

System::SharedPtr< System::Text::RegularExpressions::Matchget_Match () const
 The System::Text::RegularExpressions::Match resulting from a single regular expression match during a Replace. More...
 
System::SharedPtr< Aspose::Words::Nodeget_MatchNode () const
 Gets the node that contains the beginning of the match. More...
 
int32_t get_MatchOffset () const
 Gets the zero-based starting position of the match from the start of the node that contains the beginning of the match. More...
 
System::String get_Replacement () const
 Gets or sets the replacement string. More...
 
void set_Replacement (System::String value)
 Setter for Aspose::Words::Replacing::ReplacingArgs::get_Replacement. More...
 
System::String get_GroupName () const
 Identifies, by name, a captured group in the Aspose::Words::Replacing::ReplacingArgs::get_Match that is to be replaced with the Aspose::Words::Replacing::ReplacingArgs::get_Replacement string. More...
 
void set_GroupName (System::String value)
 Setter for Aspose::Words::Replacing::ReplacingArgs::get_GroupName. More...
 
int32_t get_GroupIndex () const
 Identifies, by index, a captured group in the Aspose::Words::Replacing::ReplacingArgs::get_Match that is to be replaced with the Aspose::Words::Replacing::ReplacingArgs::get_Replacement string. More...
 
void set_GroupIndex (int32_t value)
 Setter for Aspose::Words::Replacing::ReplacingArgs::get_GroupIndex. 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...
 

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 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)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

Provides data for a custom replace operation.

See also
Aspose::Words::Replacing::IReplacingCallback, Aspose::Words::Range, Aspose::Words::Range::Replace(System::String, System::String, System::SharedPtr<Aspose::Words::Replacing::FindReplaceOptions>)

See and its overloads.

Member Function Documentation

◆ get_GroupIndex()

int32_t Aspose::Words::Replacing::ReplacingArgs::get_GroupIndex ( ) const

◆ get_GroupName()

System::String Aspose::Words::Replacing::ReplacingArgs::get_GroupName ( ) const

Identifies, by name, a captured group in the Aspose::Words::Replacing::ReplacingArgs::get_Match that is to be replaced with the Aspose::Words::Replacing::ReplacingArgs::get_Replacement string.

When group name is null, Aspose::Words::Replacing::ReplacingArgs::get_GroupIndex is used to identify the group.

Default is null.

◆ get_Match()

System::SharedPtr<System::Text::RegularExpressions::Match> Aspose::Words::Replacing::ReplacingArgs::get_Match ( ) const

The System::Text::RegularExpressions::Match resulting from a single regular expression match during a Replace.

Match.Index" gets the zero-based starting position of the match from the start of the find and replace range.

◆ get_MatchNode()

System::SharedPtr<Aspose::Words::Node> Aspose::Words::Replacing::ReplacingArgs::get_MatchNode ( ) const

Gets the node that contains the beginning of the match.

◆ get_MatchOffset()

int32_t Aspose::Words::Replacing::ReplacingArgs::get_MatchOffset ( ) const

Gets the zero-based starting position of the match from the start of the node that contains the beginning of the match.

◆ get_Replacement()

System::String Aspose::Words::Replacing::ReplacingArgs::get_Replacement ( ) const

Gets or sets the replacement string.

◆ set_GroupIndex()

void Aspose::Words::Replacing::ReplacingArgs::set_GroupIndex ( int32_t  value)

◆ set_GroupName()

void Aspose::Words::Replacing::ReplacingArgs::set_GroupName ( System::String  value)

◆ set_Replacement()

void Aspose::Words::Replacing::ReplacingArgs::set_Replacement ( System::String  value)