Aspose::Pdf::Text::TextExtractionOptions Class Referencefinal

Represents text extraction options More...

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

Public Types

enum  TextFormattingMode { TextFormattingMode::Pure, TextFormattingMode::Raw, TextFormattingMode::MemorySaving }
 Defines different modes which can be used while converting pdf document into text. See TextDevice class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

ASPOSE_PDF_SHARED_API TextExtractionOptions::TextFormattingMode get_FormattingMode () const
 Gets formatting mode. More...
 
ASPOSE_PDF_SHARED_API void set_FormattingMode (TextExtractionOptions::TextFormattingMode value)
 Gets formatting mode. More...
 
ASPOSE_PDF_SHARED_API double get_ScaleFactor () const
 Gets factor that will be applied to scale font size during extraction in pure mode. Setting of less value leads to more spaces in the extracted text. Default value is 1 - no scaling; Setting value to zero allows algorithm choose scaling automatically. More...
 
ASPOSE_PDF_SHARED_API void set_ScaleFactor (double value)
 Sets factor that will be applied to scale font size during extraction in pure mode. Setting of less value leads to more spaces in the extracted text. Default value is 1 - no scaling; Setting value to zero allows algorithm choose scaling automatically. More...
 
ASPOSE_PDF_SHARED_API TextExtractionOptions (TextExtractionOptions::TextFormattingMode formattingMode)
 Initializes new instance of the TextExtractionOptions object for the specified text formatting 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...
 

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

Represents text extraction options

Member Enumeration Documentation

◆ TextFormattingMode

Defines different modes which can be used while converting pdf document into text. See TextDevice class.

Enumerator
Pure 

Represent pdf content with a bit of formatting routines.

Raw 

Represent pdf content as is, i.e. without formatting.

MemorySaving 

Extraction with memory saving. It is almost same to 'Raw' mode but works slightly faster and uses less memory.

Constructor & Destructor Documentation

◆ TextExtractionOptions()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextExtractionOptions::TextExtractionOptions ( TextExtractionOptions::TextFormattingMode  formattingMode)

Initializes new instance of the TextExtractionOptions object for the specified text formatting mode.

Parameters
formattingModeText formatting mode value.

Member Function Documentation

◆ get_FormattingMode()

ASPOSE_PDF_SHARED_API TextExtractionOptions::TextFormattingMode Aspose::Pdf::Text::TextExtractionOptions::get_FormattingMode ( ) const

Gets formatting mode.

◆ get_ScaleFactor()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Text::TextExtractionOptions::get_ScaleFactor ( ) const

Gets factor that will be applied to scale font size during extraction in pure mode. Setting of less value leads to more spaces in the extracted text. Default value is 1 - no scaling; Setting value to zero allows algorithm choose scaling automatically.

◆ set_FormattingMode()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextExtractionOptions::set_FormattingMode ( TextExtractionOptions::TextFormattingMode  value)

Gets formatting mode.

◆ set_ScaleFactor()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextExtractionOptions::set_ScaleFactor ( double  value)

Sets factor that will be applied to scale font size during extraction in pure mode. Setting of less value leads to more spaces in the extracted text. Default value is 1 - no scaling; Setting value to zero allows algorithm choose scaling automatically.