Represents text search options More...

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

Public Member Functions
bool	get_IsRegularExpressionUsed () const
	Gets indication that regular expression is used. More...

void	set_IsRegularExpressionUsed (bool value)
	Sets indication that regular expression is used. More...

bool	get_LimitToPageBounds () const
	Gets indication that text is searched within the page bounds. More...

void	set_LimitToPageBounds (bool value)
	Sets indication that text is searched within the page bounds. More...

System::SharedPtr< Aspose::Pdf::Rectangle >	get_Rectangle () const
	Gets rectangle that bounds the searched text. More...

void	set_Rectangle (System::SharedPtr< Aspose::Pdf::Rectangle > value)
	Sets rectangle that bounds the searched text. More...

bool	get_UseFontEngineEncoding () const
	Gets indication that text will be searched using font engine encoding. true - means that font engine encoding will be used (try this if text search fails because of imperfect encoding in the document) false - means that document font encoding will be used (default value) More...

void	set_UseFontEngineEncoding (bool value)
	Sets indication that text will be searched using font engine encoding. true - means that font engine encoding will be used (try this if text search fails because of imperfect encoding in the document) false - means that document font encoding will be used (default value) More...

bool	get_IgnoreShadowText () const
	Gets indication that text fragments representing shadow of normal text will be ignored during search. true - means that shadow text will not be found (try this if text search returns duplicated fragments on the close positions) false - means that shadow text will be found as well as normal text (default value) More...

void	set_IgnoreShadowText (bool value)
	Sets indication that text fragments representing shadow of normal text will be ignored during search. true - means that shadow text will not be found (try this if text search returns duplicated fragments on the close positions) false - means that shadow text will be found as well as normal text (default value) More...

bool	get_LogTextExtractionErrors () const
	Gets indication that text extraction (decoding) errors will be logged in the text (fragment) absorber. true - means that text extraction (decoding) errors will be loged. It may decrease performance. false (default) - no error loging. More...

void	set_LogTextExtractionErrors (bool value)
	Sets indication that text extraction (decoding) errors will be logged in the text (fragment) absorber. true - means that text extraction (decoding) errors will be loged. It may decrease performance. false (default) - no error loging. More...

bool	get_SearchForTextRelatedGraphics () const
	Gets value that permits searching for text related graphics (underlining, background etc.) during text search. false - graphic elements that may present in source document will be ignored (default value). true - searching for text related graphics will be performed. It may decrease performance of text search and edit. It also may change graphical elements that look like text related. More...

void	set_SearchForTextRelatedGraphics (bool value)
	Sets value that permits searching for text related graphics (underlining, background etc.) during text search. false - graphic elements that may present in source document will be ignored (default value). true - searching for text related graphics will be performed. It may decrease performance of text search and edit. It also may change graphical elements that look like text related. More...

	TextSearchOptions (bool isRegularExpressionUsed)
	Initializes new instance of the TextSearchOptions object. Specifies regular expression usage mode. More...

	TextSearchOptions (System::SharedPtr< Aspose::Pdf::Rectangle > rectangle)
	Initializes new instance of the TextSearchOptions object. Specifies rectangle that delimits the searched text. More...

	TextSearchOptions (System::SharedPtr< Aspose::Pdf::Rectangle > rectangle, bool isRegularExpressionUsed)
	Initializes new instance of the TextSearchOptions object. Specifies rectangle that delimits the searched text and regular expression usage 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...

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

Protected Member Functions
bool	get_SearchForClippingPaths () const
	Gets value that permits searching for text related clipping paths (invisible text boxes) during text search. false - text clipping path elements will be kept intact (default value). true - searching for text clipping path will be performed. It may decrease performance of text search and edit. It also may change graphical elements that look like text related. More...

void	set_SearchForClippingPaths (bool value)
	Sets value that permits searching for text related clipping paths (invisible text boxes) during text search. false - text clipping path elements will be kept intact (default value). true - searching for text clipping path will be performed. It may decrease performance of text search and edit. It also may change graphical elements that look like text related. More...

int32_t	get_ClippingPathsProcessing () const

void	set_ClippingPathsProcessing (int32_t value)

bool	get_IsPerformance () const
	Gets indication that fast mode will be used during search. More...

void	set_IsPerformance (bool value)
	Sets indication that fast mode will be used during search. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

typedef System::Details::SharedMembersType	shared_members_type
	structure to keep list of shared pointers contained in object. 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 ()
	Impleemnts C# typeof(System.Object) construct. More...

Detailed Description

Represents text search options

Constructor & Destructor Documentation

◆ TextSearchOptions() [1/3]

Aspose::Pdf::Text::TextSearchOptions::TextSearchOptions ( bool isRegularExpressionUsed )

Initializes new instance of the TextSearchOptions object. Specifies regular expression usage mode.

Parameters

isRegularExpressionUsed Value that indicates that regularexpression is used.

◆ TextSearchOptions() [2/3]

Aspose::Pdf::Text::TextSearchOptions::TextSearchOptions ( System::SharedPtr< Aspose::Pdf::Rectangle > rectangle )

Initializes new instance of the TextSearchOptions object. Specifies rectangle that delimits the searched text.

Parameters

rectangle Rectangle that includes the extracted text.

◆ TextSearchOptions() [3/3]

Aspose::Pdf::Text::TextSearchOptions::TextSearchOptions	(	System::SharedPtr< Aspose::Pdf::Rectangle >	rectangle,
		bool	isRegularExpressionUsed
	)

Initializes new instance of the TextSearchOptions object. Specifies rectangle that delimits the searched text and regular expression usage mode.

Parameters

rectangle	Rectangle that includes the extracted text.
isRegularExpressionUsed	Value that indicates that regularexpression is used.

Member Function Documentation

◆ get_ClippingPathsProcessing()

int32_t Aspose::Pdf::Text::TextSearchOptions::get_ClippingPathsProcessing ( ) const

protected

◆ get_IgnoreShadowText()

bool Aspose::Pdf::Text::TextSearchOptions::get_IgnoreShadowText ( ) const

Gets indication that text fragments representing shadow of normal text will be ignored during search. true - means that shadow text will not be found (try this if text search returns duplicated fragments on the close positions) false - means that shadow text will be found as well as normal text (default value)

◆ get_IsPerformance()

bool Aspose::Pdf::Text::TextSearchOptions::get_IsPerformance ( ) const

protected

Gets indication that fast mode will be used during search.

◆ get_IsRegularExpressionUsed()

bool Aspose::Pdf::Text::TextSearchOptions::get_IsRegularExpressionUsed ( ) const

Gets indication that regular expression is used.

◆ get_LimitToPageBounds()

bool Aspose::Pdf::Text::TextSearchOptions::get_LimitToPageBounds ( ) const

Gets indication that text is searched within the page bounds.

◆ get_LogTextExtractionErrors()

bool Aspose::Pdf::Text::TextSearchOptions::get_LogTextExtractionErrors ( ) const

Gets indication that text extraction (decoding) errors will be logged in the text (fragment) absorber. true - means that text extraction (decoding) errors will be loged. It may decrease performance. false (default) - no error loging.

◆ get_Rectangle()

System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Text::TextSearchOptions::get_Rectangle ( ) const

Gets rectangle that bounds the searched text.

The property may be used in case it is required to delimit text extraction or text replace region.

◆ get_SearchForClippingPaths()

bool Aspose::Pdf::Text::TextSearchOptions::get_SearchForClippingPaths ( ) const

protected

Gets value that permits searching for text related clipping paths (invisible text boxes) during text search. false - text clipping path elements will be kept intact (default value). true - searching for text clipping path will be performed. It may decrease performance of text search and edit. It also may change graphical elements that look like text related.

◆ get_SearchForTextRelatedGraphics()

bool Aspose::Pdf::Text::TextSearchOptions::get_SearchForTextRelatedGraphics ( ) const

Gets value that permits searching for text related graphics (underlining, background etc.) during text search. false - graphic elements that may present in source document will be ignored (default value). true - searching for text related graphics will be performed. It may decrease performance of text search and edit. It also may change graphical elements that look like text related.

◆ get_UseFontEngineEncoding()

bool Aspose::Pdf::Text::TextSearchOptions::get_UseFontEngineEncoding ( ) const

Gets indication that text will be searched using font engine encoding. true - means that font engine encoding will be used (try this if text search fails because of imperfect encoding in the document) false - means that document font encoding will be used (default value)

◆ set_ClippingPathsProcessing()

void Aspose::Pdf::Text::TextSearchOptions::set_ClippingPathsProcessing ( int32_t value )

protected

◆ set_IgnoreShadowText()

void Aspose::Pdf::Text::TextSearchOptions::set_IgnoreShadowText ( bool value )

Sets indication that text fragments representing shadow of normal text will be ignored during search. true - means that shadow text will not be found (try this if text search returns duplicated fragments on the close positions) false - means that shadow text will be found as well as normal text (default value)

◆ set_IsPerformance()

void Aspose::Pdf::Text::TextSearchOptions::set_IsPerformance ( bool value )

protected

Sets indication that fast mode will be used during search.

◆ set_IsRegularExpressionUsed()

void Aspose::Pdf::Text::TextSearchOptions::set_IsRegularExpressionUsed ( bool value )

Sets indication that regular expression is used.

◆ set_LimitToPageBounds()

void Aspose::Pdf::Text::TextSearchOptions::set_LimitToPageBounds ( bool value )

Sets indication that text is searched within the page bounds.

◆ set_LogTextExtractionErrors()

void Aspose::Pdf::Text::TextSearchOptions::set_LogTextExtractionErrors ( bool value )

Sets indication that text extraction (decoding) errors will be logged in the text (fragment) absorber. true - means that text extraction (decoding) errors will be loged. It may decrease performance. false (default) - no error loging.

◆ set_Rectangle()

void Aspose::Pdf::Text::TextSearchOptions::set_Rectangle ( System::SharedPtr< Aspose::Pdf::Rectangle > value )

Sets rectangle that bounds the searched text.

The property may be used in case it is required to delimit text extraction or text replace region.

◆ set_SearchForClippingPaths()

void Aspose::Pdf::Text::TextSearchOptions::set_SearchForClippingPaths ( bool value )

protected

Sets value that permits searching for text related clipping paths (invisible text boxes) during text search. false - text clipping path elements will be kept intact (default value). true - searching for text clipping path will be performed. It may decrease performance of text search and edit. It also may change graphical elements that look like text related.

◆ set_SearchForTextRelatedGraphics()

void Aspose::Pdf::Text::TextSearchOptions::set_SearchForTextRelatedGraphics ( bool value )

Sets value that permits searching for text related graphics (underlining, background etc.) during text search. false - graphic elements that may present in source document will be ignored (default value). true - searching for text related graphics will be performed. It may decrease performance of text search and edit. It also may change graphical elements that look like text related.

◆ set_UseFontEngineEncoding()

void Aspose::Pdf::Text::TextSearchOptions::set_UseFontEngineEncoding ( bool value )

Sets indication that text will be searched using font engine encoding. true - means that font engine encoding will be used (try this if text search fails because of imperfect encoding in the document) false - means that document font encoding will be used (default value)

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextSearchOptions() [1/3]

◆ TextSearchOptions() [2/3]

◆ TextSearchOptions() [3/3]

Member Function Documentation

◆ get_ClippingPathsProcessing()

◆ get_IgnoreShadowText()

◆ get_IsPerformance()

◆ get_IsRegularExpressionUsed()

◆ get_LimitToPageBounds()

◆ get_LogTextExtractionErrors()

◆ get_Rectangle()

◆ get_SearchForClippingPaths()

◆ get_SearchForTextRelatedGraphics()

◆ get_UseFontEngineEncoding()

◆ set_ClippingPathsProcessing()

◆ set_IgnoreShadowText()

◆ set_IsPerformance()

◆ set_IsRegularExpressionUsed()

◆ set_LimitToPageBounds()

◆ set_LogTextExtractionErrors()

◆ set_Rectangle()

◆ set_SearchForClippingPaths()

◆ set_SearchForTextRelatedGraphics()

◆ set_UseFontEngineEncoding()