Class for extracting images and text from PDF document. More...

#include "PdfExtractor.h"

Public Member Functions
ASPOSE_PDF_SHARED_API int32_t	get_StartPage () const
	Gets start page in the page range where extracting operation will be performed. More...

ASPOSE_PDF_SHARED_API void	set_StartPage (int32_t value)
	Sets start page in the page range where extracting operation will be performed. More...

ASPOSE_PDF_SHARED_API int32_t	get_EndPage () const
	Gets end page in the page range where extracting operation will be performed. More...

ASPOSE_PDF_SHARED_API void	set_EndPage (int32_t value)
	Sets end page in the page range where extracting operation will be performed. More...

ASPOSE_PDF_SHARED_API int32_t	get_ExtractTextMode () const
	Sets the mode for extract text's result. More...

ASPOSE_PDF_SHARED_API void	set_ExtractTextMode (int32_t value)
	Sets the mode for extract text's result. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions >	get_TextSearchOptions () const
	Gets text search options. More...

ASPOSE_PDF_SHARED_API void	set_TextSearchOptions (System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions > value)
	Sets text search options. More...

ASPOSE_PDF_SHARED_API Aspose::Pdf::ExtractImageMode	get_ExtractImageMode () const
	Sets the mode for extract images process. More...

ASPOSE_PDF_SHARED_API void	set_ExtractImageMode (Aspose::Pdf::ExtractImageMode value)
	Sets the mode for extract images process. More...

ASPOSE_PDF_SHARED_API bool	get_IsBidi ()
	Is true when text has hebriew or arabic symbols. This case must be specially considered because string functions change their behaviour and start process text from right to left (except numbers and other non text chars). More...

ASPOSE_PDF_SHARED_API int32_t	get_Resolution () const
	Set or gets resolution for extracted images. Default value is 150. Images which have greater resolution value are more clear. However increasing resolution value results in increasing time and memory needed to extract images. Usually to get clear image it's enough to set resolution to 150 or 300. More...

ASPOSE_PDF_SHARED_API void	set_Resolution (int32_t value)
	Set or gets resolution for extracted images. Default value is 150. Images which have greater resolution value are more clear. However increasing resolution value results in increasing time and memory needed to extract images. Usually to get clear image it's enough to set resolution to 150 or 300. More...

ASPOSE_PDF_SHARED_API System::String	get_Password () const
	Gets input file's password. More...

ASPOSE_PDF_SHARED_API void	set_Password (System::String value)
	Sets input file's password. More...

ASPOSE_PDF_SHARED_API void	ExtractText ()
	Extracts text from a Pdf document using Unicode encoding. More...

ASPOSE_PDF_SHARED_API void	ExtractText (System::SharedPtr< System::Text::Encoding > encoding)
	Extracts text from a Pdf document using specified encoding. More...

ASPOSE_PDF_SHARED_API void	GetText (System::String outputFile)
	Saves text to file. see also:ExtractText More...

ASPOSE_PDF_SHARED_API void	GetText (System::SharedPtr< System::IO::Stream > outputStream)
	Saves text to stream. see also:ExtractText More...

ASPOSE_PDF_SHARED_API void	BindPdf (System::String inputFile) override
	Bind input PDF file. More...

ASPOSE_PDF_SHARED_API void	BindPdf (System::SharedPtr< System::IO::Stream > inputStream) override
	Binds PDF document from stream. More...

ASPOSE_PDF_SHARED_API void	ExtractImage ()
	Extract images from PDF file. More...

ASPOSE_PDF_SHARED_API bool	HasNextImage ()
	Checks if more images are accessible in PDF document. Note: ExtractImage must be called before using of this method. More...

ASPOSE_PDF_SHARED_API bool	GetNextImage (System::String outputFile)
	Retrieves next image from PDF document. Note: ExtractImage must be called before using of this method. More...

ASPOSE_PDF_SHARED_API bool	GetNextImage (System::String outputFile, System::SharedPtr< System::Drawing::Imaging::ImageFormat > format)
	Retrieves next image from PDF document with given image format. Note: ExtractImage must be called before using of this method. More...

ASPOSE_PDF_SHARED_API bool	GetNextImage (System::SharedPtr< System::IO::Stream > outputStream, System::SharedPtr< System::Drawing::Imaging::ImageFormat > format)
	Retrieve next image from PDF file and stores it into stream with given image format. More...

ASPOSE_PDF_SHARED_API bool	GetNextImage (System::SharedPtr< System::IO::Stream > outputStream)
	Retrieve next image from PDF file and stores it into stream. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IList< System::String > >	GetAttachNames ()
	Returns list of attachments in PDF file. Note: ExtractAttachments must be called before using this method. More...

ASPOSE_PDF_SHARED_API void	ExtractAttachment ()
	Extracts attachments from a Pdf document. More...

ASPOSE_PDF_SHARED_API void	ExtractAttachment (System::String attachmentFileName)
	Extracts attachment to PDF file by attachment name. More...

ASPOSE_PDF_SHARED_API void	GetAttachment (System::String outputPath)
	Stores attachment into file. More...

ASPOSE_PDF_SHARED_API bool	HasNextPageText ()
	Indicates that whether can get more texts or not. More...

ASPOSE_PDF_SHARED_API void	GetNextPageText (System::String outputFile)
	Saves one page's text to file. More...

ASPOSE_PDF_SHARED_API void	GetNextPageText (System::SharedPtr< System::IO::Stream > outputStream)
	Saves one page's text to stream. More...

ASPOSE_PDF_SHARED_API	PdfExtractor ()
	Initializes new PdfExtractor object. More...

ASPOSE_PDF_SHARED_API	PdfExtractor (System::SharedPtr< Aspose::Pdf::Document > document)
	Initializes new PdfExtractor object on base of the document . More...

ASPOSE_PDF_SHARED_API void	GetText (System::SharedPtr< System::IO::Stream > outputStream, bool filterNotAscii)
	Saves text to stream. see also:ExtractText More...

ASPOSE_PDF_SHARED_API System::ArrayPtr< System::SharedPtr< System::IO::MemoryStream > >	GetAttachment ()
	Saves all the attachment file to streams. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< FileSpecification > > >	GetAttachmentInfo ()
	Gets the list of attachments. More...

Public Member Functions inherited from Aspose::Pdf::Facades::Facade
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Document >	get_Document () const
	Gets the document facade is working on. More...

ASPOSE_PDF_SHARED_API void	BindPdf (System::SharedPtr< Aspose::Pdf::Document > srcDoc) override
	Initializes the facade. More...

ASPOSE_PDF_SHARED_API void	Close () override
	Disposes Aspose.Pdf.Document bound with a facade. More...

ASPOSE_PDF_SHARED_API void	Dispose () override
	Disposes the facade. More...

Public Member Functions inherited from Aspose::Pdf::Facades::IFacade
virtual void	BindPdf (System::SharedPtr< Document > srcDoc)=0
	Binds PDF document for editing. 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...

Protected Member Functions
bool	get__IsObjectLicensed ()
	Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise. More...

void	SetVentureLicense (System::SharedPtr< Aspose::Pdf::LicenseManagement::VentureLicense > license) override

System::SharedPtr< Aspose::Pdf::LicenseManagement::VentureLicense >	GetVentureLicense () override

void	InitPageImages (System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XImage >>> images, System::SharedPtr< Aspose::Pdf::Document > document, int32_t page, int32_t endPage)

void	InitPageXFormImages_DefinedInResources (System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XImage >>> images, System::SharedPtr< Aspose::Pdf::Document > document, int32_t page, int32_t endPage)

Protected Member Functions inherited from Aspose::Pdf::Facades::Facade
bool	get__IsObjectLicensed ()
	Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise. More...

ASPOSE_PDF_SHARED_API	Facade ()
	The constructor. More...

ASPOSE_PDF_SHARED_API	Facade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
	The constructor. More...

virtual ASPOSE_PDF_SHARED_API void	BindPdf (System::String srcFile, System::String password)
	Initializes the facade. More...

virtual ASPOSE_PDF_SHARED_API void	BindPdf (System::SharedPtr< System::IO::Stream > srcStream, System::String password)
	Initializes the facade. More...

virtual ASPOSE_PDF_SHARED_API void	AssertDocument () const
	Asserts if the facade is initialized. More...

virtual ASPOSE_PDF_SHARED_API	~Facade ()

Static Protected Member Functions
static void	InitXFormImages (System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XImage >>> images, System::SharedPtr< System::Collections::Generic::List< int32_t >> processedObjectIds, System::SharedPtr< XForm > xForm)

static void	InitPageXFormImages_ActuallyUsed (System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XImage >>> images, System::SharedPtr< Aspose::Pdf::Document > document, int32_t page, int32_t endPage)

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...

Detailed Description

Class for extracting images and text from PDF document.

Constructor & Destructor Documentation

◆ PdfExtractor() [1/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfExtractor::PdfExtractor ( )

Initializes new PdfExtractor object.

◆ PdfExtractor() [2/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfExtractor::PdfExtractor ( System::SharedPtr< Aspose::Pdf::Document > document )

Initializes new PdfExtractor object on base of the document .

Parameters

document Pdf document.

Member Function Documentation

◆ BindPdf() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::BindPdf ( System::String inputFile )

overridevirtual

Bind input PDF file.

Parameters

inputFile PDF file to bind

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ BindPdf() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::BindPdf ( System::SharedPtr< System::IO::Stream > inputStream )

overridevirtual

Binds PDF document from stream.

Parameters

inputStream Stream containing PDF document data

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ ExtractAttachment() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::ExtractAttachment ( )

Extracts attachments from a Pdf document.

◆ ExtractAttachment() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::ExtractAttachment ( System::String attachmentFileName )

Extracts attachment to PDF file by attachment name.

Parameters

attachmentFileName Name of attachment to extract

◆ ExtractImage()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::ExtractImage ( )

Extract images from PDF file.

◆ ExtractText() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::ExtractText ( )

Extracts text from a Pdf document using Unicode encoding.

◆ ExtractText() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::ExtractText ( System::SharedPtr< System::Text::Encoding > encoding )

Extracts text from a Pdf document using specified encoding.

Parameters

encoding The encoding of the extracted text.

◆ get__IsObjectLicensed()

bool Aspose::Pdf::Facades::PdfExtractor::get__IsObjectLicensed ( )

protected

Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise.

◆ get_EndPage()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfExtractor::get_EndPage ( ) const

Gets end page in the page range where extracting operation will be performed.

◆ get_ExtractImageMode()

ASPOSE_PDF_SHARED_API Aspose::Pdf::ExtractImageMode Aspose::Pdf::Facades::PdfExtractor::get_ExtractImageMode ( ) const

Sets the mode for extract images process.

Default value is ExtractImageMode.DefinedInResources that extracts all images defined in resources.

To extract actually shown images ExtractImageMode.ActuallyUsed mode should be used.

◆ get_ExtractTextMode()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfExtractor::get_ExtractTextMode ( ) const

Sets the mode for extract text's result.

0 is pure text mode and 1 is raw ordering mode. Default is 0.

◆ get_IsBidi()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfExtractor::get_IsBidi ( )

Is true when text has hebriew or arabic symbols. This case must be specially considered because string functions change their behaviour and start process text from right to left (except numbers and other non text chars).

◆ get_Password()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::PdfExtractor::get_Password ( ) const

Gets input file's password.

◆ get_Resolution()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfExtractor::get_Resolution ( ) const

Set or gets resolution for extracted images. Default value is 150. Images which have greater resolution value are more clear. However increasing resolution value results in increasing time and memory needed to extract images. Usually to get clear image it's enough to set resolution to 150 or 300.

◆ get_StartPage()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfExtractor::get_StartPage ( ) const

Gets start page in the page range where extracting operation will be performed.

◆ get_TextSearchOptions()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Text::TextSearchOptions> Aspose::Pdf::Facades::PdfExtractor::get_TextSearchOptions ( ) const

Gets text search options.

◆ GetAttachment() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::GetAttachment ( System::String outputPath )

Stores attachment into file.

Parameters

outputPath Directory path where attachment(s) will be stored. Null or empty string means attachment(s) will be placed in the application directory.

◆ GetAttachment() [2/2]

ASPOSE_PDF_SHARED_API System::ArrayPtr<System::SharedPtr<System::IO::MemoryStream> > Aspose::Pdf::Facades::PdfExtractor::GetAttachment ( )

Saves all the attachment file to streams.

Returns: The stream array of the attachment file in the pdf document.

◆ GetAttachmentInfo()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<FileSpecification> > > Aspose::Pdf::Facades::PdfExtractor::GetAttachmentInfo ( )

Gets the list of attachments.

Returns: Returns a List<FileSpecificatio>>.

◆ GetAttachNames()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IList<System::String> > Aspose::Pdf::Facades::PdfExtractor::GetAttachNames ( )

Returns list of attachments in PDF file. Note: ExtractAttachments must be called before using this method.

Returns: List of attachments

◆ GetNextImage() [1/4]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfExtractor::GetNextImage ( System::String outputFile )

Retrieves next image from PDF document. Note: ExtractImage must be called before using of this method.

Parameters

outputFile File where image will be stored

Returns: True is image is successfully extracted

◆ GetNextImage() [2/4]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfExtractor::GetNextImage	(	System::String	outputFile,
		System::SharedPtr< System::Drawing::Imaging::ImageFormat >	format
	)

Retrieves next image from PDF document with given image format. Note: ExtractImage must be called before using of this method.

Parameters

outputFile	File where image will be stored
format	The format of the image.

Returns: True is image is successfully extracted

◆ GetNextImage() [3/4]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfExtractor::GetNextImage	(	System::SharedPtr< System::IO::Stream >	outputStream,
		System::SharedPtr< System::Drawing::Imaging::ImageFormat >	format
	)

Retrieve next image from PDF file and stores it into stream with given image format.

Parameters

outputStream	Stream where image data will be saved
format	The format of the image.

Returns: True in case the image is successfully extracted.

◆ GetNextImage() [4/4]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfExtractor::GetNextImage ( System::SharedPtr< System::IO::Stream > outputStream )

Retrieve next image from PDF file and stores it into stream.

Parameters

outputStream Stream where image data will be saved

Returns: True in case the image is successfully extracted.

◆ GetNextPageText() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::GetNextPageText ( System::String outputFile )

Saves one page's text to file.

Parameters

outputFile The file path and name to save the text.

◆ GetNextPageText() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::GetNextPageText ( System::SharedPtr< System::IO::Stream > outputStream )

Saves one page's text to stream.

Parameters

outputStream The stream to save the text.

◆ GetText() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::GetText ( System::String outputFile )

Saves text to file. see also:ExtractText

Parameters

outputFile The file path and name to save the text.

◆ GetText() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::GetText ( System::SharedPtr< System::IO::Stream > outputStream )

Saves text to stream. see also:ExtractText

Parameters

outputStream The stream to save the text.

◆ GetText() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::GetText	(	System::SharedPtr< System::IO::Stream >	outputStream,
		bool	filterNotAscii
	)

Saves text to stream. see also:ExtractText

Parameters

outputStream	The stream to save the text.
filterNotAscii	If this parameter is true all Not ASCII symbols will be removed

◆ GetVentureLicense()

System::SharedPtr<Aspose::Pdf::LicenseManagement::VentureLicense> Aspose::Pdf::Facades::PdfExtractor::GetVentureLicense ( )

overrideprotected

◆ HasNextImage()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfExtractor::HasNextImage ( )

Checks if more images are accessible in PDF document. Note: ExtractImage must be called before using of this method.

Returns: Trues if more images are accessible

◆ HasNextPageText()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfExtractor::HasNextPageText ( )

Indicates that whether can get more texts or not.

Returns: Can get more texts or not, true is can, or false.

◆ InitPageImages()

void Aspose::Pdf::Facades::PdfExtractor::InitPageImages	(	System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XImage >>>	images,
		System::SharedPtr< Aspose::Pdf::Document >	document,
		int32_t	page,
		int32_t	endPage
	)

protected

◆ InitPageXFormImages_ActuallyUsed()

static void Aspose::Pdf::Facades::PdfExtractor::InitPageXFormImages_ActuallyUsed	(	System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XImage >>>	images,
		System::SharedPtr< Aspose::Pdf::Document >	document,
		int32_t	page,
		int32_t	endPage
	)

staticprotected

◆ InitPageXFormImages_DefinedInResources()

void Aspose::Pdf::Facades::PdfExtractor::InitPageXFormImages_DefinedInResources	(	System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XImage >>>	images,
		System::SharedPtr< Aspose::Pdf::Document >	document,
		int32_t	page,
		int32_t	endPage
	)

protected

◆ InitXFormImages()

static void Aspose::Pdf::Facades::PdfExtractor::InitXFormImages	(	System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XImage >>>	images,
		System::SharedPtr< System::Collections::Generic::List< int32_t >>	processedObjectIds,
		System::SharedPtr< XForm >	xForm
	)

staticprotected

◆ set_EndPage()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::set_EndPage ( int32_t value )

Sets end page in the page range where extracting operation will be performed.

◆ set_ExtractImageMode()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::set_ExtractImageMode ( Aspose::Pdf::ExtractImageMode value )

Sets the mode for extract images process.

Default value is ExtractImageMode.DefinedInResources that extracts all images defined in resources.

To extract actually shown images ExtractImageMode.ActuallyUsed mode should be used.

◆ set_ExtractTextMode()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::set_ExtractTextMode ( int32_t value )

Sets the mode for extract text's result.

0 is pure text mode and 1 is raw ordering mode. Default is 0.

◆ set_Password()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::set_Password ( System::String value )

Sets input file's password.

◆ set_Resolution()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::set_Resolution ( int32_t value )

Set or gets resolution for extracted images. Default value is 150. Images which have greater resolution value are more clear. However increasing resolution value results in increasing time and memory needed to extract images. Usually to get clear image it's enough to set resolution to 150 or 300.

◆ set_StartPage()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::set_StartPage ( int32_t value )

Sets start page in the page range where extracting operation will be performed.

◆ set_TextSearchOptions()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfExtractor::set_TextSearchOptions ( System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions > value )

Sets text search options.

◆ SetVentureLicense()

void Aspose::Pdf::Facades::PdfExtractor::SetVentureLicense ( System::SharedPtr< Aspose::Pdf::LicenseManagement::VentureLicense > license )

overrideprotected

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfExtractor() [1/2]

◆ PdfExtractor() [2/2]

Member Function Documentation

◆ BindPdf() [1/2]

◆ BindPdf() [2/2]

◆ ExtractAttachment() [1/2]

◆ ExtractAttachment() [2/2]

◆ ExtractImage()

◆ ExtractText() [1/2]

◆ ExtractText() [2/2]

◆ get__IsObjectLicensed()

◆ get_EndPage()

◆ get_ExtractImageMode()

◆ get_ExtractTextMode()

◆ get_IsBidi()

◆ get_Password()

◆ get_Resolution()

◆ get_StartPage()

◆ get_TextSearchOptions()

◆ GetAttachment() [1/2]

◆ GetAttachment() [2/2]

◆ GetAttachmentInfo()

◆ GetAttachNames()

◆ GetNextImage() [1/4]

◆ GetNextImage() [2/4]

◆ GetNextImage() [3/4]

◆ GetNextImage() [4/4]

◆ GetNextPageText() [1/2]

◆ GetNextPageText() [2/2]

◆ GetText() [1/3]

◆ GetText() [2/3]

◆ GetText() [3/3]

◆ GetVentureLicense()

◆ HasNextImage()

◆ HasNextPageText()

◆ InitPageImages()

◆ InitPageXFormImages_ActuallyUsed()

◆ InitPageXFormImages_DefinedInResources()

◆ InitXFormImages()

◆ set_EndPage()

◆ set_ExtractImageMode()

◆ set_ExtractTextMode()

◆ set_Password()

◆ set_Resolution()

◆ set_StartPage()

◆ set_TextSearchOptions()

◆ SetVentureLicense()