Represents options for the PdfToImage plugin. More...

#include "PdfToImageOptions.h"

Inherits Aspose::Pdf::Plugins::IPluginOptions, Aspose::Pdf::Plugins::IDataContainer, and Aspose::Pdf::Plugins::ISaveInstruction.

Inherited by Aspose::Pdf::Plugins::JpegOptions, Aspose::Pdf::Plugins::PngOptions, and Aspose::Pdf::Plugins::TiffOptions.

Public Types
enum	ImageConversionMode { ImageConversionMode::None }
	Defines different modes which can be used while converting from PDF document to Jpeg image. See JpegOptions class. More...

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

Public Member Functions
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< IDataSource > > >	get_Inputs () override
	Returns PdfToImage plugin data collection. More...

virtual ASPOSE_PDF_SHARED_API System::String	get_OperationName ()
	Returns operation name. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< IDataSource > > >	get_Outputs () override
	Gets the collection of added targets (file or stream data sources) for saving operation results. More...

ASPOSE_PDF_SHARED_API PdfToImageOptions::ImageConversionMode	get_ConversionMode ()
	Gets image conversion mode. More...

ASPOSE_PDF_SHARED_API const System::SharedPtr< System::Collections::Generic::List< int32_t > > &	get_PageList () const
	Gets a list of pages for the process. More...

ASPOSE_PDF_SHARED_API void	set_PageList (System::SharedPtr< System::Collections::Generic::List< int32_t >> value)
	Sets a list of pages for the process. More...

ASPOSE_PDF_SHARED_API int32_t	get_OutputResolution () const
	Gets the resolution value of the resulting images. More...

ASPOSE_PDF_SHARED_API void	set_OutputResolution (int32_t value)
	Sets the resolution value of the resulting images. More...

ASPOSE_PDF_SHARED_API void	AddInput (System::SharedPtr< IDataSource > dataSource) override
	Adds new data source to the PdfToImage plugin data collection. More...

ASPOSE_PDF_SHARED_API void	AddOutput (System::SharedPtr< IDataSource > saveDataSource) override
	Sets new save data source. Can only be a See also FileDataSource . If you want save images into memory streams, pass null as parameter. 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
System::SharedPtr< FileDataSource >	get_Destination ()
	Gets See also FileDataSource destination. More...

	PdfToImageOptions ()
	Initializes a new instance of the PdfToImageOptions object. More...

virtual System::SharedPtr< Aspose::Pdf::Devices::PageDevice >	GetImageDevice ()=0

virtual ASPOSE_PDF_SHARED_API bool	ProcessAsMultipage ()

Static Protected Attributes
static const ASPOSE_PDF_SHARED_API int32_t	defaultOutputImageResolution

static const ASPOSE_PDF_SHARED_API int32_t	defaultOutputImageJpegQuality

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 TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

Detailed Description

Represents options for the PdfToImage plugin.

The PdfImageOptions class contains base functions to add data (files, streams) representing input PDF documents.

Member Enumeration Documentation

◆ ImageConversionMode

enum Aspose::Pdf::Plugins::PdfToImageOptions::ImageConversionMode

strong

Defines different modes which can be used while converting from PDF document to Jpeg image. See JpegOptions class.

Enumerator
None	Default mode.

Constructor & Destructor Documentation

◆ PdfToImageOptions()

Aspose::Pdf::Plugins::PdfToImageOptions::PdfToImageOptions ( )

protected

Initializes a new instance of the PdfToImageOptions object.

Member Function Documentation

◆ AddInput()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Plugins::PdfToImageOptions::AddInput ( System::SharedPtr< IDataSource > dataSource )

overridevirtual

Adds new data source to the PdfToImage plugin data collection.

Parameters

dataSource Data source to add.

Implements Aspose::Pdf::Plugins::IDataContainer.

◆ AddOutput()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Plugins::PdfToImageOptions::AddOutput ( System::SharedPtr< IDataSource > saveDataSource )

overridevirtual

Sets new save data source. Can only be a

See also: FileDataSource

. If you want save images into memory streams, pass null as parameter.

Parameters

saveDataSource Save data source.

Implements Aspose::Pdf::Plugins::ISaveInstruction.

◆ get_ConversionMode()

ASPOSE_PDF_SHARED_API PdfToImageOptions::ImageConversionMode Aspose::Pdf::Plugins::PdfToImageOptions::get_ConversionMode ( )

Gets image conversion mode.

◆ get_Destination()

System::SharedPtr<FileDataSource> Aspose::Pdf::Plugins::PdfToImageOptions::get_Destination ( )

protected

Gets

See also: FileDataSource

destination.

◆ get_Inputs()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<IDataSource> > > Aspose::Pdf::Plugins::PdfToImageOptions::get_Inputs ( )

overridevirtual

Returns PdfToImage plugin data collection.

Implements Aspose::Pdf::Plugins::IDataContainer.

◆ get_OperationName()

virtual ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Plugins::PdfToImageOptions::get_OperationName ( )

virtual

Returns operation name.

Reimplemented in Aspose::Pdf::Plugins::TiffOptions, Aspose::Pdf::Plugins::PngOptions, and Aspose::Pdf::Plugins::JpegOptions.

◆ get_OutputResolution()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Plugins::PdfToImageOptions::get_OutputResolution ( ) const

Gets the resolution value of the resulting images.

◆ get_Outputs()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<IDataSource> > > Aspose::Pdf::Plugins::PdfToImageOptions::get_Outputs ( )

overridevirtual

Gets the collection of added targets (file or stream data sources) for saving operation results.

Implements Aspose::Pdf::Plugins::ISaveInstruction.

◆ get_PageList()

ASPOSE_PDF_SHARED_API const System::SharedPtr<System::Collections::Generic::List<int32_t> >& Aspose::Pdf::Plugins::PdfToImageOptions::get_PageList ( ) const

Gets a list of pages for the process.

◆ GetImageDevice()

virtual System::SharedPtr<Aspose::Pdf::Devices::PageDevice> Aspose::Pdf::Plugins::PdfToImageOptions::GetImageDevice ( )

protectedpure virtual

Implemented in Aspose::Pdf::Plugins::TiffOptions, Aspose::Pdf::Plugins::JpegOptions, and Aspose::Pdf::Plugins::PngOptions.

◆ ProcessAsMultipage()

virtual ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Plugins::PdfToImageOptions::ProcessAsMultipage ( )

protectedvirtual

Reimplemented in Aspose::Pdf::Plugins::TiffOptions.

◆ set_OutputResolution()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Plugins::PdfToImageOptions::set_OutputResolution ( int32_t value )

Sets the resolution value of the resulting images.

◆ set_PageList()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Plugins::PdfToImageOptions::set_PageList ( System::SharedPtr< System::Collections::Generic::List< int32_t >> value )

Sets a list of pages for the process.

Member Data Documentation

◆ defaultOutputImageJpegQuality

const ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Plugins::PdfToImageOptions::defaultOutputImageJpegQuality

staticprotected

◆ defaultOutputImageResolution

const ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Plugins::PdfToImageOptions::defaultOutputImageResolution

staticprotected

Public Types

Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ImageConversionMode

Constructor & Destructor Documentation

◆ PdfToImageOptions()

Member Function Documentation

◆ AddInput()

◆ AddOutput()

◆ get_ConversionMode()

◆ get_Destination()

◆ get_Inputs()

◆ get_OperationName()

◆ get_OutputResolution()

◆ get_Outputs()

◆ get_PageList()

◆ GetImageDevice()

◆ ProcessAsMultipage()

◆ set_OutputResolution()

◆ set_PageList()

Member Data Documentation

◆ defaultOutputImageJpegQuality

◆ defaultOutputImageResolution