Aspose::Pdf::Text::TextEditOptions Class Referencefinal

Descubes options of text edit operations. More...

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

Public Types

enum  NoCharacterAction { NoCharacterAction::ThrowException, NoCharacterAction::UseStandardFont, NoCharacterAction::ReplaceAnyway, NoCharacterAction::UseCustomReplacementFont }
 Action to perform if font does not contain required character More...
 
enum  FontReplace { FontReplace::Default, FontReplace::RemoveUnusedFonts }
 Font replacement behavior. More...
 
enum  LanguageTransformation { LanguageTransformation::Default, LanguageTransformation::ExactlyAsISee, LanguageTransformation::None }
 Language transformation modes More...
 
enum  ClippingPathsProcessingMode { ClippingPathsProcessingMode::KeepIntact, ClippingPathsProcessingMode::Expand, ClippingPathsProcessingMode::Remove }
 Clipping path processing modes More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< Fontget_ReplacementFont () const
 Gets font used for replacing if user font does not contain required character More...
 
ASPOSE_PDF_SHARED_API void set_ReplacementFont (System::SharedPtr< Font > value)
 Sets font used for replacing if user font does not contain required character More...
 
ASPOSE_PDF_SHARED_API TextEditOptions::NoCharacterAction get_NoCharacterBehavior () const
 Gets mode that defines behavior in case fonts don't contain requested characters. More...
 
ASPOSE_PDF_SHARED_API void set_NoCharacterBehavior (TextEditOptions::NoCharacterAction value)
 Sets mode that defines behavior in case fonts don't contain requested characters. More...
 
ASPOSE_PDF_SHARED_API TextEditOptions::FontReplace get_FontReplaceBehavior () const
 Gets mode that defines behavior for fonts replacement scenarios. More...
 
ASPOSE_PDF_SHARED_API void set_FontReplaceBehavior (TextEditOptions::FontReplace value)
 Gets mode that defines behavior for fonts replacement scenarios. More...
 
ASPOSE_PDF_SHARED_API bool get_AllowLanguageTransformation () const
 Gets value that permits usage of language transformation during adding or editing of text. true - language transformation will be applied if necessary (default value). false - language transformation will NOT be applied. More...
 
ASPOSE_PDF_SHARED_API void set_AllowLanguageTransformation (bool value)
 Sets value that permits usage of language transformation during adding or editing of text. true - language transformation will be applied if necessary (default value). false - language transformation will NOT be applied. More...
 
ASPOSE_PDF_SHARED_API TextEditOptions::LanguageTransformation get_LanguageTransformationBehavior () const
 Gets mode that defines behavior for language transformation scenarios. More...
 
ASPOSE_PDF_SHARED_API void set_LanguageTransformationBehavior (TextEditOptions::LanguageTransformation value)
 Gets mode that defines behavior for language transformation scenarios. More...
 
ASPOSE_PDF_SHARED_API TextEditOptions::ClippingPathsProcessingMode get_ClippingPathsProcessing () const
 Gets mode for processing clipping path of the edited text. More...
 
ASPOSE_PDF_SHARED_API void set_ClippingPathsProcessing (TextEditOptions::ClippingPathsProcessingMode value)
 Gets mode for processing clipping path of the edited text. More...
 
ASPOSE_PDF_SHARED_API bool get_ToAttemptGetUnderlineFromSource () const
 Gets value that permits searching for text underlining on the page of source document. (Obsolete) Please use TextSearchOptions.SearchForTextRelatedGraphics instead this. More...
 
ASPOSE_PDF_SHARED_API void set_ToAttemptGetUnderlineFromSource (bool value)
 Sets value that permits searching for text underlining on the page of source document. (Obsolete) Please use TextSearchOptions.SearchForTextRelatedGraphics instead this. More...
 
ASPOSE_PDF_SHARED_API TextEditOptions (TextEditOptions::NoCharacterAction noCharacterBehavior)
 Initializes new instance of the TextEditOptions object for the specified no-character behavior mode. More...
 
ASPOSE_PDF_SHARED_API TextEditOptions (TextEditOptions::FontReplace fontReplaceBehavior)
 Initializes new instance of the TextEditOptions object for the specified font replacement behavior mode. More...
 
ASPOSE_PDF_SHARED_API TextEditOptions (bool allowLanguageTransformation)
 Initializes new instance of the TextEditOptions object for the specified language transformation permission. More...
 
ASPOSE_PDF_SHARED_API TextEditOptions (TextEditOptions::LanguageTransformation languageTransformationBehavior)
 Initializes new instance of the TextEditOptions object for the specified language transformation behavior mode. 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...
 

Protected Types

enum  TextRearrangement { TextRearrangement::None, TextRearrangement::Auto }
 Text rearrangement modes More...
 

Protected Member Functions

TextEditOptions::TextRearrangement get_RearrangementMode () const
 Gets mode that defines text rearrangement behavior. More...
 
void set_RearrangementMode (TextEditOptions::TextRearrangement value)
 Gets mode that defines text rearrangement behavior. More...
 
bool get_IsMassOperation () const
 Indicates that mass operation will performed. It instructs TextFragmentAbsorber (and underlying logic) to omit some checkings. It is for performance. That checkings are necessary if not all text segments are affected by operation. Don't set this to 'true' if you aren't sure that all text operators must be affected. More...
 
void set_IsMassOperation (bool value)
 Indicates that mass operation will performed. It instructs TextFragmentAbsorber (and underlying logic) to omit some checkings. It is for performance. That checkings are necessary if not all text segments are affected by operation. Don't set this to 'true' if you aren't sure that all text operators must be affected. More...
 
 TextEditOptions (TextEditOptions::TextRearrangement rearrangementMode)
 Initializes new instance of the TextEditOptions object for the specified text rearrangement mode. More...
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (TextEditOptions, CODEPORTING_ARGS(TextEditOptions::TextRearrangement rearrangementMode))
 

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

Descubes options of text edit operations.

Member Enumeration Documentation

◆ ClippingPathsProcessingMode

Clipping path processing modes

Enumerator
KeepIntact 

Keeps clipping paths of the original page layout. (Default)

Expand 

Original clipping path will be expanded in the case edited text requires more space.

Remove 

Original clipping path will be removed in the case edited text requires more space. Caution: Because of clipping paths may interact with each other removing of it may lead to unexpected result on the page layout.

◆ FontReplace

Font replacement behavior.

Enumerator
Default 

No additional changes performed during font replacement.

RemoveUnusedFonts 

Fonts that become unused during font replacement will be removed from resulting document.

◆ LanguageTransformation

Language transformation modes

Enumerator
Default 

Default language transformation is performed.

ExactlyAsISee 

Language transformation is performed the same way as in a text editor. It usually means text will looks in the document exactly as You see it in code. But no warranties.

None 

Language transformation is not performed.

◆ NoCharacterAction

Action to perform if font does not contain required character

Enumerator
ThrowException 

Throw exception

UseStandardFont 

Repalce font to standard font which contains required character

ReplaceAnyway 

Replace text anyway without font substitution

UseCustomReplacementFont 

Repalce font to defined replacement font

◆ TextRearrangement

Text rearrangement modes

Enumerator
None 

Text rearrangement is not performed.

Auto 

Text rearrangement is performed automatically.

Constructor & Destructor Documentation

◆ TextEditOptions() [1/5]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextEditOptions::TextEditOptions ( TextEditOptions::NoCharacterAction  noCharacterBehavior)

Initializes new instance of the TextEditOptions object for the specified no-character behavior mode.

Parameters
noCharacterBehaviorNo-character behavior mode object.

◆ TextEditOptions() [2/5]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextEditOptions::TextEditOptions ( TextEditOptions::FontReplace  fontReplaceBehavior)

Initializes new instance of the TextEditOptions object for the specified font replacement behavior mode.

Parameters
fontReplaceBehaviorFont replace behavior object.

◆ TextEditOptions() [3/5]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextEditOptions::TextEditOptions ( bool  allowLanguageTransformation)

Initializes new instance of the TextEditOptions object for the specified language transformation permission.

Parameters
allowLanguageTransformationAllows language transformation if set to true.

◆ TextEditOptions() [4/5]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextEditOptions::TextEditOptions ( TextEditOptions::LanguageTransformation  languageTransformationBehavior)

Initializes new instance of the TextEditOptions object for the specified language transformation behavior mode.

Parameters
languageTransformationBehaviorlanguage transformation behavior object.

◆ TextEditOptions() [5/5]

Aspose::Pdf::Text::TextEditOptions::TextEditOptions ( TextEditOptions::TextRearrangement  rearrangementMode)
protected

Initializes new instance of the TextEditOptions object for the specified text rearrangement mode.

Parameters
rearrangementModeRearrangement mode object.

Member Function Documentation

◆ get_AllowLanguageTransformation()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Text::TextEditOptions::get_AllowLanguageTransformation ( ) const

Gets value that permits usage of language transformation during adding or editing of text. true - language transformation will be applied if necessary (default value). false - language transformation will NOT be applied.

◆ get_ClippingPathsProcessing()

ASPOSE_PDF_SHARED_API TextEditOptions::ClippingPathsProcessingMode Aspose::Pdf::Text::TextEditOptions::get_ClippingPathsProcessing ( ) const

Gets mode for processing clipping path of the edited text.

◆ get_FontReplaceBehavior()

ASPOSE_PDF_SHARED_API TextEditOptions::FontReplace Aspose::Pdf::Text::TextEditOptions::get_FontReplaceBehavior ( ) const

Gets mode that defines behavior for fonts replacement scenarios.

◆ get_IsMassOperation()

bool Aspose::Pdf::Text::TextEditOptions::get_IsMassOperation ( ) const
protected

Indicates that mass operation will performed. It instructs TextFragmentAbsorber (and underlying logic) to omit some checkings. It is for performance. That checkings are necessary if not all text segments are affected by operation. Don't set this to 'true' if you aren't sure that all text operators must be affected.

◆ get_LanguageTransformationBehavior()

ASPOSE_PDF_SHARED_API TextEditOptions::LanguageTransformation Aspose::Pdf::Text::TextEditOptions::get_LanguageTransformationBehavior ( ) const

Gets mode that defines behavior for language transformation scenarios.

◆ get_NoCharacterBehavior()

ASPOSE_PDF_SHARED_API TextEditOptions::NoCharacterAction Aspose::Pdf::Text::TextEditOptions::get_NoCharacterBehavior ( ) const

Gets mode that defines behavior in case fonts don't contain requested characters.

◆ get_RearrangementMode()

TextEditOptions::TextRearrangement Aspose::Pdf::Text::TextEditOptions::get_RearrangementMode ( ) const
protected

Gets mode that defines text rearrangement behavior.

◆ get_ReplacementFont()

ASPOSE_PDF_SHARED_API System::SharedPtr<Font> Aspose::Pdf::Text::TextEditOptions::get_ReplacementFont ( ) const

Gets font used for replacing if user font does not contain required character

◆ get_ToAttemptGetUnderlineFromSource()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Text::TextEditOptions::get_ToAttemptGetUnderlineFromSource ( ) const

Gets value that permits searching for text underlining on the page of source document. (Obsolete) Please use TextSearchOptions.SearchForTextRelatedGraphics instead this.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Text::TextEditOptions::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( TextEditOptions  ,
CODEPORTING_ARGS(TextEditOptions::TextRearrangement rearrangementMode)   
)
protected

◆ set_AllowLanguageTransformation()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextEditOptions::set_AllowLanguageTransformation ( bool  value)

Sets value that permits usage of language transformation during adding or editing of text. true - language transformation will be applied if necessary (default value). false - language transformation will NOT be applied.

◆ set_ClippingPathsProcessing()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextEditOptions::set_ClippingPathsProcessing ( TextEditOptions::ClippingPathsProcessingMode  value)

Gets mode for processing clipping path of the edited text.

◆ set_FontReplaceBehavior()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextEditOptions::set_FontReplaceBehavior ( TextEditOptions::FontReplace  value)

Gets mode that defines behavior for fonts replacement scenarios.

◆ set_IsMassOperation()

void Aspose::Pdf::Text::TextEditOptions::set_IsMassOperation ( bool  value)
protected

Indicates that mass operation will performed. It instructs TextFragmentAbsorber (and underlying logic) to omit some checkings. It is for performance. That checkings are necessary if not all text segments are affected by operation. Don't set this to 'true' if you aren't sure that all text operators must be affected.

◆ set_LanguageTransformationBehavior()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextEditOptions::set_LanguageTransformationBehavior ( TextEditOptions::LanguageTransformation  value)

Gets mode that defines behavior for language transformation scenarios.

◆ set_NoCharacterBehavior()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextEditOptions::set_NoCharacterBehavior ( TextEditOptions::NoCharacterAction  value)

Sets mode that defines behavior in case fonts don't contain requested characters.

◆ set_RearrangementMode()

void Aspose::Pdf::Text::TextEditOptions::set_RearrangementMode ( TextEditOptions::TextRearrangement  value)
protected

Gets mode that defines text rearrangement behavior.

◆ set_ReplacementFont()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextEditOptions::set_ReplacementFont ( System::SharedPtr< Font value)

Sets font used for replacing if user font does not contain required character

◆ set_ToAttemptGetUnderlineFromSource()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextEditOptions::set_ToAttemptGetUnderlineFromSource ( bool  value)

Sets value that permits searching for text underlining on the page of source document. (Obsolete) Please use TextSearchOptions.SearchForTextRelatedGraphics instead this.