Represents an absorber object of text fragments. Performs text search and provides access to search results via TextFragmentAbsorber::TextFragments collection. More...

#include "TextFragmentAbsorber.h"

Inherits Aspose::Pdf::Text::TextAbsorber.

Public Member Functions
ASPOSE_PDF_SHARED_API System::SharedPtr< TextFragmentCollection >	get_TextFragments ()
	Gets collection of search occurrences that are presented with TextFragment objects. More...

ASPOSE_PDF_SHARED_API void	set_TextFragments (System::SharedPtr< TextFragmentCollection > value)
	Gets collection of search occurrences that are presented with TextFragment objects. More...

ASPOSE_PDF_SHARED_API System::String	get_Phrase () const
	Gets phrase that the TextFragmentAbsorber searches on the PDF document or page. More...

ASPOSE_PDF_SHARED_API void	set_Phrase (System::String value)
	Sets phrase that the TextFragmentAbsorber searches on the PDF document or page. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions >	get_TextSearchOptions () override
	Gets search options. The options enable search using regular expressions. More...

ASPOSE_PDF_SHARED_API void	set_TextSearchOptions (System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions > value) override
	Sets search options. The options enable search using regular expressions. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Text::TextEditOptions >	get_TextEditOptions () const
	Gets text edit options. The options define special behavior when requested symbol cannot be written with font. More...

ASPOSE_PDF_SHARED_API void	set_TextEditOptions (System::SharedPtr< Aspose::Pdf::Text::TextEditOptions > value)
	Sets text edit options. The options define special behavior when requested symbol cannot be written with font. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Text::TextReplaceOptions >	get_TextReplaceOptions () const
	Gets text replace options. The options define behavior when fragment text is replaced to more short/long. More...

ASPOSE_PDF_SHARED_API void	set_TextReplaceOptions (System::SharedPtr< Aspose::Pdf::Text::TextReplaceOptions > value)
	Sets text replace options. The options define behavior when fragment text is replaced to more short/long. More...

ASPOSE_PDF_SHARED_API bool	get_HasErrors () const
	Value indicates whether errors were found during text extraction. Searching for errors will performed only if TextSearchOptions.LogTextExtractionErrors = true; And it may decrease performance. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< TextExtractionError > > >	get_Errors () const
	List of TextExtractionError objects. It contain information about errors were found during text extraction. Searching for errors will performed only if TextSearchOptions.LogTextExtractionErrors = true; And it may decrease performance. More...

ASPOSE_PDF_SHARED_API System::String	get_Text () override
	Gets extracted text that the TextAbsorber extracts on the PDF document or page. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< TextExtractionOptions >	get_ExtractionOptions () override
	Gets text extraction options. More...

ASPOSE_PDF_SHARED_API void	set_ExtractionOptions (System::SharedPtr< TextExtractionOptions > value) override
	Sets text extraction options. More...

ASPOSE_PDF_SHARED_API	TextFragmentAbsorber ()
	Initializes a new instance of the TextFragmentAbsorber that performs search of all text segments of the document or page. More...

ASPOSE_PDF_SHARED_API	TextFragmentAbsorber (System::SharedPtr< Aspose::Pdf::Text::TextEditOptions > textEditOptions)
	Initializes a new instance of the TextFragmentAbsorber with text edit options, that performs search of all text segments of the document or page. More...

ASPOSE_PDF_SHARED_API	TextFragmentAbsorber (System::String phrase)
	Initializes a new instance of the TextFragmentAbsorber class for the specified text phrase. More...

ASPOSE_PDF_SHARED_API	TextFragmentAbsorber (System::SharedPtr< System::Text::RegularExpressions::Regex > regex)
	Initializes a new instance of the TextFragmentAbsorber class for the specified System.Text.RegularExpressions.Regex class object. More...

ASPOSE_PDF_SHARED_API	TextFragmentAbsorber (System::String phrase, System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions > textSearchOptions)
	Initializes a new instance of the TextFragmentAbsorber class for the specified text phrase and text search options. More...

ASPOSE_PDF_SHARED_API	TextFragmentAbsorber (System::SharedPtr< System::Text::RegularExpressions::Regex > regex, System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions > textSearchOptions)
	Initializes a new instance of the TextFragmentAbsorber class for the specified text phrase and text search options. More...

ASPOSE_PDF_SHARED_API	TextFragmentAbsorber (System::String phrase, System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions > textSearchOptions, System::SharedPtr< Aspose::Pdf::Text::TextEditOptions > textEditOptions)
	Initializes a new instance of the TextFragmentAbsorber class for the specified text phrase, text search options and text edit options. More...

ASPOSE_PDF_SHARED_API	TextFragmentAbsorber (System::String phrase, System::SharedPtr< Aspose::Pdf::Text::TextEditOptions > textEditOptions)
	Initializes a new instance of the TextFragmentAbsorber class for the specified text phrase and text edit options. More...

ASPOSE_PDF_SHARED_API	TextFragmentAbsorber (System::SharedPtr< System::Text::RegularExpressions::Regex > regex, System::SharedPtr< Aspose::Pdf::Text::TextEditOptions > textEditOptions)
	Initializes a new instance of the TextFragmentAbsorber class for the specified text phrase and text edit options. More...

ASPOSE_PDF_SHARED_API void	Visit (System::SharedPtr< Page > page) override
	Performs search on the specified page. More...

ASPOSE_PDF_SHARED_API void	Visit (System::SharedPtr< Document > pdf) override
	Performs search on the specified document. More...

ASPOSE_PDF_SHARED_API void	ApplyForAllFragments (System::SharedPtr< Font > font)
	Applies font for all text fragments that were absorbed. It works faster than looping through the fragments if all fragments on the page(s) were absorbed. Otherwise it works similar with looping. More...

ASPOSE_PDF_SHARED_API void	ApplyForAllFragments (float fontSize)
	Applies font size for all text fragments that were absorbed. It works faster than looping through the fragments if all fragments on the page(s) were absorbed. Otherwise it works similar with looping. More...

ASPOSE_PDF_SHARED_API void	ApplyForAllFragments (System::SharedPtr< Font > font, float fontSize)
	Applies font and size for all text fragments that were absorbed. It works faster than looping through the fragments if all fragments on the page(s) were absorbed. Otherwise it works similar with looping. More...

ASPOSE_PDF_SHARED_API void	Reset ()
	Clears TextFragments collection of this TextFragmentAbsorber object. More...

ASPOSE_PDF_SHARED_API void	RemoveAllText (System::SharedPtr< Page > page)
	Removes all text from the specified page. More...

ASPOSE_PDF_SHARED_API void	RemoveAllText (System::SharedPtr< Page > page, System::SharedPtr< Rectangle > rect)
	Removes text inside the specified rectangle from the specified page. More...

ASPOSE_PDF_SHARED_API void	RemoveAllText (System::SharedPtr< Document > document)
	Removes all text from the document. More...

ASPOSE_PDF_SHARED_API void	Visit (System::SharedPtr< XForm > xForm) override
	Performs search on the specified form object. More...

Public Member Functions inherited from Aspose::Pdf::Text::TextAbsorber
ASPOSE_PDF_SHARED_API bool	get_HasErrors () const
	Value indicates whether errors were found during text extraction. Searching for errors will performed only if TextSearchOptions.LogTextExtractionErrors = true; And it may decrease performance. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< TextExtractionError > > >	get_Errors () const
	List of TextExtractionError objects. It contain information about errors were found during text extraction. Searching for errors will performed only if TextSearchOptions.LogTextExtractionErrors = true; And it may decrease performance. More...

ASPOSE_PDF_SHARED_API	TextAbsorber ()
	Initializes a new instance of the TextAbsorber. More...

ASPOSE_PDF_SHARED_API	TextAbsorber (System::SharedPtr< TextExtractionOptions > extractionOptions)
	Initializes a new instance of the TextAbsorber with extraction options. More...

ASPOSE_PDF_SHARED_API	TextAbsorber (System::SharedPtr< TextExtractionOptions > extractionOptions, System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions > textSearchOptions)
	Initializes a new instance of the TextAbsorber with extraction and text search options. More...

ASPOSE_PDF_SHARED_API	TextAbsorber (System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions > textSearchOptions)
	Initializes a new instance of the TextAbsorber with text search options. 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. 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 TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

Protected Member Functions inherited from Aspose::Pdf::Text::TextAbsorber
System::SharedPtr< System::Collections::Generic::List< int32_t > >	get_PageTextLengthes () const

System::String	GetTotalText (System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::TextSegmenter > segmenter, TextExtractionOptions::TextFormattingMode mode)

Protected Attributes inherited from Aspose::Pdf::Text::TextAbsorber
System::SharedPtr< System::Text::StringBuilder >	extractedText

Detailed Description

Represents an absorber object of text fragments. Performs text search and provides access to search results via TextFragmentAbsorber::TextFragments collection.

The TextFragmentAbsorber object is basically used in text search scenario. When the search is completed the occurrences are represented with TextFragment objects that the TextFragmentAbsorber::TextFragments collection contains. The TextFragment object provides access to the search occurrence text, text properties, and allows to edit text and change the text state (font, font size, color etc).

Constructor & Destructor Documentation

◆ TextFragmentAbsorber() [1/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFragmentAbsorber::TextFragmentAbsorber ( )

Initializes a new instance of the TextFragmentAbsorber that performs search of all text segments of the document or page.

Performs text search and provides access to search results via TextFragmentAbsorber::TextFragments collection.

◆ TextFragmentAbsorber() [2/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFragmentAbsorber::TextFragmentAbsorber ( System::SharedPtr< Aspose::Pdf::Text::TextEditOptions > textEditOptions )

Initializes a new instance of the TextFragmentAbsorber with text edit options, that performs search of all text segments of the document or page.

Performs text search and provides access to search results via TextFragmentAbsorber::TextFragments collection.

Parameters

textEditOptions Text edit options (Allows to turn on some edit features).

◆ TextFragmentAbsorber() [3/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFragmentAbsorber::TextFragmentAbsorber ( System::String phrase )

Initializes a new instance of the TextFragmentAbsorber class for the specified text phrase.