Aspose::Pdf::Text::TextReplaceOptions Class Referencefinal

Represents text replace options More...

Inherits Aspose::Pdf::Text::TextOptions.

Public Types

enum  Scope { Scope::REPLACE_FIRST, Scope::REPLACE_ALL }
 Scope where replace text operation is applied REPLACE_FIRST by default This obsolete option was kept for compatibility. It affects to PdfContentEditor and has no effect to TextFragmentAbsorber. More...
 
enum  ReplaceAdjustment { ReplaceAdjustment::None = 0, ReplaceAdjustment::AdjustSpaceWidth = 1, ReplaceAdjustment::WholeWordsHyphenation = 2, ReplaceAdjustment::ShiftRestOfLine = 4 }
 Determines action that will be done after replace of text fragment to more short. None - no action, replaced text may overlaps rest of the line; AdjustSpaceWidth - tries adjust spaces between words to keep line length; WholeWordsHyphenation - tries distribute words between paragraph lines to keep paragraph's right field; ShiftRestOfLine - shifts rest of the line according to changing length of text, length of the line may be changed; Default value is ShiftRestOfLine. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

ASPOSE_PDF_SHARED_API TextReplaceOptions::Scope get_ReplaceScope () const
 Gets a scope where replace text operation is applied More...
 
ASPOSE_PDF_SHARED_API void set_ReplaceScope (TextReplaceOptions::Scope value)
 Sets a scope where replace text operation is applied More...
 
ASPOSE_PDF_SHARED_API TextReplaceOptions::ReplaceAdjustment get_ReplaceAdjustmentAction () const
 Gets an action that will be done after replace of text fragment to more short. More...
 
ASPOSE_PDF_SHARED_API void set_ReplaceAdjustmentAction (TextReplaceOptions::ReplaceAdjustment value)
 Sets an action that will be done after replace of text fragment to more short. More...
 
ASPOSE_PDF_SHARED_API double get_AdjustmentNewLineSpacing () const
 Gets value of line spacing that used if replace adjustment is forced to create new line of text. The value expected is multiplier of font size of the replaced text. Default is 1.2. More...
 
ASPOSE_PDF_SHARED_API void set_AdjustmentNewLineSpacing (double value)
 Sets value of line spacing that used if replace adjustment is forced to create new line of text. The value expected is multiplier of font size of the replaced text. Default is 1.2. More...
 
ASPOSE_PDF_SHARED_API TextReplaceOptions (TextReplaceOptions::Scope scope)
 Initializes new instance of the TextReplaceOptions object for the specified scope. More...
 
ASPOSE_PDF_SHARED_API TextReplaceOptions (TextReplaceOptions::ReplaceAdjustment adjustment)
 Initializes new instance of the TextReplaceOptions object for the specified after replace action. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API 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 reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- 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 ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents text replace options

Member Enumeration Documentation

◆ ReplaceAdjustment

Determines action that will be done after replace of text fragment to more short. None - no action, replaced text may overlaps rest of the line; AdjustSpaceWidth - tries adjust spaces between words to keep line length; WholeWordsHyphenation - tries distribute words between paragraph lines to keep paragraph's right field; ShiftRestOfLine - shifts rest of the line according to changing length of text, length of the line may be changed; Default value is ShiftRestOfLine.

Enumerator
None 

No action, replaced text may overlaps rest of the line

AdjustSpaceWidth 

Tries adjust spaces between words to keep line length

WholeWordsHyphenation 

Tries distribute words between paragraph lines to keep paragraph's right field

ShiftRestOfLine 

(Default) Shifts rest of the line according to changing length of text, length of the line may be changed

◆ Scope

Scope where replace text operation is applied REPLACE_FIRST by default This obsolete option was kept for compatibility. It affects to PdfContentEditor and has no effect to TextFragmentAbsorber.

Enumerator
REPLACE_FIRST 

Replace only first occurrence of the text on each of affected pages

REPLACE_ALL 

Replace all text occurrences on all affected pages

Constructor & Destructor Documentation

◆ TextReplaceOptions() [1/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextReplaceOptions::TextReplaceOptions ( TextReplaceOptions::Scope  scope)

Initializes new instance of the TextReplaceOptions object for the specified scope.

Parameters
scopeScope object.

◆ TextReplaceOptions() [2/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextReplaceOptions::TextReplaceOptions ( TextReplaceOptions::ReplaceAdjustment  adjustment)

Initializes new instance of the TextReplaceOptions object for the specified after replace action.

Parameters
adjustmentReplaceAdjustment object.

Member Function Documentation

◆ get_AdjustmentNewLineSpacing()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Text::TextReplaceOptions::get_AdjustmentNewLineSpacing ( ) const

Gets value of line spacing that used if replace adjustment is forced to create new line of text. The value expected is multiplier of font size of the replaced text. Default is 1.2.

◆ get_ReplaceAdjustmentAction()

ASPOSE_PDF_SHARED_API TextReplaceOptions::ReplaceAdjustment Aspose::Pdf::Text::TextReplaceOptions::get_ReplaceAdjustmentAction ( ) const

Gets an action that will be done after replace of text fragment to more short.

◆ get_ReplaceScope()

ASPOSE_PDF_SHARED_API TextReplaceOptions::Scope Aspose::Pdf::Text::TextReplaceOptions::get_ReplaceScope ( ) const

Gets a scope where replace text operation is applied

◆ set_AdjustmentNewLineSpacing()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextReplaceOptions::set_AdjustmentNewLineSpacing ( double  value)

Sets value of line spacing that used if replace adjustment is forced to create new line of text. The value expected is multiplier of font size of the replaced text. Default is 1.2.

◆ set_ReplaceAdjustmentAction()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextReplaceOptions::set_ReplaceAdjustmentAction ( TextReplaceOptions::ReplaceAdjustment  value)

Sets an action that will be done after replace of text fragment to more short.

◆ set_ReplaceScope()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextReplaceOptions::set_ReplaceScope ( TextReplaceOptions::Scope  value)

Sets a scope where replace text operation is applied