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

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...

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...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 

Public Member Functions

TextReplaceOptions::Scope get_ReplaceScope () const
 Gets a scope where replace text operation is applied More...
 
void set_ReplaceScope (TextReplaceOptions::Scope value)
 Sets a scope where replace text operation is applied More...
 
TextReplaceOptions::ReplaceAdjustment get_ReplaceAdjustmentAction () const
 Gets an action that will be done after replace of text fragment to more short. More...
 
void set_ReplaceAdjustmentAction (TextReplaceOptions::ReplaceAdjustment value)
 Sets an action that will be done after replace of text fragment to more short. More...
 
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...
 
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...
 
 TextReplaceOptions (TextReplaceOptions::Scope scope)
 Initializes new instance of the TextReplaceOptions object for the specified scope. More...
 
 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 refernce 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 int 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 (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 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)
 

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

Detailed Description

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.

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::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::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()

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()

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()

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

Gets a scope where replace text operation is applied

◆ set_AdjustmentNewLineSpacing()

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()

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()

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

Sets a scope where replace text operation is applied