Aspose::Pdf::Text::TextFragmentAbsorber Class Referencefinal

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< TextFragmentCollectionget_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::SharedPtr< System::Collections::Generic::Dictionary< System::SharedPtr< System::Text::RegularExpressions::Regex >, System::SharedPtr< TextFragmentCollection > > > get_RegexResults () const
 Gets dictionary of search occurrences that are presented with System.Text.RegularExpressions.Regex class as key and TextFragment as value. 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::TextSearchOptionsget_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::TextEditOptionsget_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::TextReplaceOptionsget_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< TextExtractionOptionsget_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::ArrayPtr< System::SharedPtr< System::Text::RegularExpressions::Regex >> regexes, 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...
 
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

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 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 TypeInfoType ()
 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::StringBuilderextractedText
 

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/10]

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/10]

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
textEditOptionsText edit options (Allows to turn on some edit features).

◆ TextFragmentAbsorber() [3/10]

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.

Performs text search of the specified phrase and provides access to search results via TextFragmentAbsorber::TextFragments collection.

Parameters
phrasePhrase that the TextFragmentAbsorber searches

◆ TextFragmentAbsorber() [4/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFragmentAbsorber::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.

Performs text search of the specified phrase and provides access to search results via TextFragmentAbsorber::TextFragments collection.

Parameters
regexSystem.Text.RegularExpressions.Regex class object that the TextFragmentAbsorber searches

◆ TextFragmentAbsorber() [5/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFragmentAbsorber::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.

Performs text search of the specified phrase and provides access to search results via TextFragmentAbsorber::TextFragments collection.

Parameters
phrasePhrase that the TextFragmentAbsorber searches
textSearchOptionsText search options (Allows to turn on some search features. For example, search with regular expression)

◆ TextFragmentAbsorber() [6/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFragmentAbsorber::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.

Performs text search of the specified phrase and provides access to search results via TextFragmentAbsorber::TextFragments collection.

Parameters
regexSystem.Text.RegularExpressions.Regex class object that the TextFragmentAbsorber searches
textSearchOptionsText search options (Allows to turn on some search features.)

◆ TextFragmentAbsorber() [7/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFragmentAbsorber::TextFragmentAbsorber ( System::ArrayPtr< System::SharedPtr< System::Text::RegularExpressions::Regex >>  regexes,
System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions textSearchOptions 
)

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

Performs text search of the specified array of phrases and provides access to search results via TextFragmentAbsorber::RegexResults dictionary.

Parameters
regexesArray of System.Text.RegularExpressions.Regex class object that the TextFragmentAbsorber searches.
textSearchOptionsText search options (Allows to turn on some search features.).

◆ TextFragmentAbsorber() [8/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFragmentAbsorber::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.

Performs text search of the specified phrase and provides access to search results via TextFragmentAbsorber::TextFragments collection.

Parameters
phrasePhrase that the TextFragmentAbsorber searches
textSearchOptionsText search options (Allows to turn on some search features. For example, search with regular expression)
textEditOptionsText edit options (Allows to turn on some edit features).

◆ TextFragmentAbsorber() [9/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFragmentAbsorber::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.

Performs text search of the specified phrase and provides access to search results via TextFragmentAbsorber::TextFragments collection.

Parameters
phrasePhrase that the TextFragmentAbsorber searches
textEditOptionsText edit options (Allows to turn on some edit features).

◆ TextFragmentAbsorber() [10/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFragmentAbsorber::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.

Performs text search of the specified phrase and provides access to search results via TextFragmentAbsorber::TextFragments collection.

Parameters
regexSystem.Text.RegularExpressions.Regex class object that the TextFragmentAbsorber searches
textEditOptionsText edit options (Allows to turn on some edit features).

Member Function Documentation

◆ ApplyForAllFragments() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::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.

Parameters
fontFontof the text.

◆ ApplyForAllFragments() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::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.

Parameters
fontSizeFont size of the text.

◆ ApplyForAllFragments() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::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.

Parameters
fontFontof the text.
fontSizeFont size of the text.

◆ get_Errors()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<TextExtractionError> > > Aspose::Pdf::Text::TextFragmentAbsorber::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.

◆ get_ExtractionOptions()

ASPOSE_PDF_SHARED_API System::SharedPtr<TextExtractionOptions> Aspose::Pdf::Text::TextFragmentAbsorber::get_ExtractionOptions ( )
overridevirtual

Gets text extraction options.

Reimplemented from Aspose::Pdf::Text::TextAbsorber.

◆ get_HasErrors()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Text::TextFragmentAbsorber::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.

◆ get_Phrase()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Text::TextFragmentAbsorber::get_Phrase ( ) const

Gets phrase that the TextFragmentAbsorber searches on the PDF document or page.

◆ get_RegexResults()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::Dictionary<System::SharedPtr<System::Text::RegularExpressions::Regex>, System::SharedPtr<TextFragmentCollection> > > Aspose::Pdf::Text::TextFragmentAbsorber::get_RegexResults ( ) const

Gets dictionary of search occurrences that are presented with System.Text.RegularExpressions.Regex class as key and TextFragment as value.

◆ get_Text()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Text::TextFragmentAbsorber::get_Text ( )
overridevirtual

Gets extracted text that the TextAbsorber extracts on the PDF document or page.

Reimplemented from Aspose::Pdf::Text::TextAbsorber.

◆ get_TextEditOptions()

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

Gets text edit options. The options define special behavior when requested symbol cannot be written with font.

◆ get_TextFragments()

ASPOSE_PDF_SHARED_API System::SharedPtr<TextFragmentCollection> Aspose::Pdf::Text::TextFragmentAbsorber::get_TextFragments ( )

Gets collection of search occurrences that are presented with TextFragment objects.

◆ get_TextReplaceOptions()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Text::TextReplaceOptions> Aspose::Pdf::Text::TextFragmentAbsorber::get_TextReplaceOptions ( ) const

Gets text replace options. The options define behavior when fragment text is replaced to more short/long.

◆ get_TextSearchOptions()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Text::TextSearchOptions> Aspose::Pdf::Text::TextFragmentAbsorber::get_TextSearchOptions ( )
overridevirtual

Gets search options. The options enable search using regular expressions.

Reimplemented from Aspose::Pdf::Text::TextAbsorber.

◆ RemoveAllText() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::RemoveAllText ( System::SharedPtr< Page page)

Removes all text from the specified page.

Parameters
pagePDF document page object.

◆ RemoveAllText() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::RemoveAllText ( System::SharedPtr< Page page,
System::SharedPtr< Rectangle rect 
)

Removes text inside the specified rectangle from the specified page.

Parameters
pagePDF document page object.
rectRectangle to remove text inside.

◆ RemoveAllText() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::RemoveAllText ( System::SharedPtr< Document document)

Removes all text from the document.

Parameters
documentPDF document object.

◆ Reset()

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

Clears TextFragments collection of this TextFragmentAbsorber object.

◆ set_ExtractionOptions()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::set_ExtractionOptions ( System::SharedPtr< TextExtractionOptions value)
overridevirtual

Sets text extraction options.

Reimplemented from Aspose::Pdf::Text::TextAbsorber.

◆ set_Phrase()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::set_Phrase ( System::String  value)

Sets phrase that the TextFragmentAbsorber searches on the PDF document or page.

◆ set_TextEditOptions()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::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.

◆ set_TextFragments()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::set_TextFragments ( System::SharedPtr< TextFragmentCollection value)

Gets collection of search occurrences that are presented with TextFragment objects.

◆ set_TextReplaceOptions()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::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.

◆ set_TextSearchOptions()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::set_TextSearchOptions ( System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions value)
overridevirtual

Sets search options. The options enable search using regular expressions.

Reimplemented from Aspose::Pdf::Text::TextAbsorber.

◆ Visit() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::Visit ( System::SharedPtr< Page page)
overridevirtual

Performs search on the specified page.

Parameters
pagePDF document page object.

Reimplemented from Aspose::Pdf::Text::TextAbsorber.

◆ Visit() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::Visit ( System::SharedPtr< Document pdf)
overridevirtual

Performs search on the specified document.

Parameters
pdfPDF document object.

Reimplemented from Aspose::Pdf::Text::TextAbsorber.

◆ Visit() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFragmentAbsorber::Visit ( System::SharedPtr< XForm xForm)
overridevirtual

Performs search on the specified form object.

Parameters
xFormPdf form object.

Reimplemented from Aspose::Pdf::Text::TextAbsorber.