Aspose::Pdf::Devices::ImageDevice Class Reference

An abstract class for image devices. More...

#include "ImageDevice.h"

Inherits Aspose::Pdf::Devices::PageDevice.

Inherited by Aspose::Pdf::Devices::BmpDevice, Aspose::Pdf::Devices::EmfDevice, Aspose::Pdf::Devices::GifDevice, Aspose::Pdf::Devices::JpegDevice, and Aspose::Pdf::Devices::PngDevice.

Public Member Functions

ASPOSE_PDF_SHARED_API PageCoordinateType get_CoordinateType () const
 Gets the page coordinate type (Media/Crop boxes). CropBox value is used by default. More...
 
ASPOSE_PDF_SHARED_API void set_CoordinateType (PageCoordinateType value)
 Sets the page coordinate type (Media/Crop boxes). CropBox value is used by default. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::RenderingOptionsget_RenderingOptions () const
 Gets rendering options. More...
 
ASPOSE_PDF_SHARED_API void set_RenderingOptions (System::SharedPtr< Aspose::Pdf::RenderingOptions > value)
 Sets rendering options. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::FormPresentationMode get_FormPresentationMode () const
 Gets form presentation mode. More...
 
ASPOSE_PDF_SHARED_API void set_FormPresentationMode (Aspose::Pdf::Devices::FormPresentationMode value)
 Sets form presentation mode. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Devices::Resolutionget_Resolution () const
 Gets image resolution. More...
 
ASPOSE_PDF_SHARED_API int32_t get_Width () const
 Gets image output width. More...
 
ASPOSE_PDF_SHARED_API int32_t get_Height () const
 Gets image output height. More...
 
ASPOSE_PDF_SHARED_API ImageDevice ()
 Abstract initializer for ImageDevice descendants, set resolution to 150x150. More...
 
ASPOSE_PDF_SHARED_API ImageDevice (System::SharedPtr< Aspose::Pdf::Devices::Resolution > resolution)
 Abstract initializer for ImageDevice descendants.
Parameters
resolutionResolution for the result image file, see Resolution class.
More...
 
ASPOSE_PDF_SHARED_API ImageDevice (int32_t width, int32_t height)
 Initializes a new instance of the JpegDevice class with provided image dimensions and default resolution (=150). More...
 
ASPOSE_PDF_SHARED_API ImageDevice (System::SharedPtr< PageSize > pageSize)
 Initializes a new instance of the JpegDevice class with provided image dimensions and default resolution (=150). More...
 
ASPOSE_PDF_SHARED_API ImageDevice (int32_t width, int32_t height, System::SharedPtr< Aspose::Pdf::Devices::Resolution > resolution)
 Initializes a new instance of the JpegDevice class with provided image dimensions and resolution. More...
 
ASPOSE_PDF_SHARED_API ImageDevice (System::SharedPtr< PageSize > pageSize, System::SharedPtr< Aspose::Pdf::Devices::Resolution > resolution)
 Initializes a new instance of the JpegDevice class with provided image dimensions and resolution. More...
 
- Public Member Functions inherited from Aspose::Pdf::Devices::PageDevice
virtual ASPOSE_PDF_SHARED_API void Process (System::SharedPtr< Page > page, System::SharedPtr< System::IO::Stream > output)=0
 Perfoms some operation on the given page, e.g. converts page into graphic image. More...
 
ASPOSE_PDF_SHARED_API void Process (System::SharedPtr< Page > page, System::String outputFileName)
 Perfoms some operation on the given page and saves results into the file. 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...
 

Protected Member Functions

 ImageDevice (System::SharedPtr< Point > origin, int32_t paperWidth, int32_t paperHeight, System::Drawing::Rectangle marginBounds, float scaleFactor, System::SharedPtr< Aspose::Pdf::Devices::Resolution > resolution, int32_t rotateDegrees, bool autoSize, VerticalAlignment verticalAlignment, HorizontalAlignment horizontalAlignment, bool isIsXpsPrinting)
 
System::SharedPtr< Aspose::Pdf::Engine::Presentation::IPresenter > ProcessPresentation (System::SharedPtr< Page > page)
 processes current page and returns presenter More...
 
System::SharedPtr< Aspose::Pdf::Engine::Presentation::IPresenter > ProcessPresentation (System::SharedPtr< Page > page, System::SharedPtr< System::Drawing::Graphics > gr)
 processes current page with the graphics and returns presenter More...
 
- Protected Member Functions inherited from Aspose::Pdf::Devices::PageDevice
virtual ASPOSE_PDF_SHARED_API void Process (System::SharedPtr< Page > page, System::SharedPtr< System::Drawing::Graphics > gr)
 renders page on the graphics More...
 
- Protected Member Functions inherited from Aspose::Pdf::Devices::Device
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Documentget_Document () const
 Document which is processed by this device instance. More...
 
ASPOSE_PDF_SHARED_API void set_Document (System::SharedPtr< Aspose::Pdf::Document > value)
 Document which is processed by this device instance. 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...
 

Detailed Description

An abstract class for image devices.

Constructor & Destructor Documentation

◆ ImageDevice() [1/7]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::ImageDevice::ImageDevice ( )

Abstract initializer for ImageDevice descendants, set resolution to 150x150.

◆ ImageDevice() [2/7]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::ImageDevice::ImageDevice ( System::SharedPtr< Aspose::Pdf::Devices::Resolution resolution)

Abstract initializer for ImageDevice descendants.

Parameters
resolutionResolution for the result image file, see Resolution class.

◆ ImageDevice() [3/7]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::ImageDevice::ImageDevice ( int32_t  width,
int32_t  height 
)

Initializes a new instance of the JpegDevice class with provided image dimensions and default resolution (=150).

Parameters
widthImage output width.
heightImage output height.

◆ ImageDevice() [4/7]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::ImageDevice::ImageDevice ( System::SharedPtr< PageSize pageSize)

Initializes a new instance of the JpegDevice class with provided image dimensions and default resolution (=150).

Parameters
pageSizePage size of the output image.

◆ ImageDevice() [5/7]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::ImageDevice::ImageDevice ( int32_t  width,
int32_t  height,
System::SharedPtr< Aspose::Pdf::Devices::Resolution resolution 
)

Initializes a new instance of the JpegDevice class with provided image dimensions and resolution.

Parameters
widthImage output width.
heightImage output height.
resolutionResolution for the result image file, see Resolution class.

◆ ImageDevice() [6/7]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::ImageDevice::ImageDevice ( System::SharedPtr< PageSize pageSize,
System::SharedPtr< Aspose::Pdf::Devices::Resolution resolution 
)

Initializes a new instance of the JpegDevice class with provided image dimensions and resolution.

Parameters
pageSizePage size of the output image.
resolutionResolution for the result image file, see Resolution class.

◆ ImageDevice() [7/7]

Aspose::Pdf::Devices::ImageDevice::ImageDevice ( System::SharedPtr< Point origin,
int32_t  paperWidth,
int32_t  paperHeight,
System::Drawing::Rectangle  marginBounds,
float  scaleFactor,
System::SharedPtr< Aspose::Pdf::Devices::Resolution resolution,
int32_t  rotateDegrees,
bool  autoSize,
VerticalAlignment  verticalAlignment,
HorizontalAlignment  horizontalAlignment,
bool  isIsXpsPrinting 
)
protected

Member Function Documentation

◆ get_CoordinateType()

ASPOSE_PDF_SHARED_API PageCoordinateType Aspose::Pdf::Devices::ImageDevice::get_CoordinateType ( ) const

Gets the page coordinate type (Media/Crop boxes). CropBox value is used by default.

◆ get_FormPresentationMode()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::FormPresentationMode Aspose::Pdf::Devices::ImageDevice::get_FormPresentationMode ( ) const

Gets form presentation mode.

◆ get_Height()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Devices::ImageDevice::get_Height ( ) const

Gets image output height.

◆ get_RenderingOptions()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::RenderingOptions> Aspose::Pdf::Devices::ImageDevice::get_RenderingOptions ( ) const

Gets rendering options.

◆ get_Resolution()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Devices::Resolution> Aspose::Pdf::Devices::ImageDevice::get_Resolution ( ) const

Gets image resolution.

◆ get_Width()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Devices::ImageDevice::get_Width ( ) const

Gets image output width.

◆ ProcessPresentation() [1/2]

System::SharedPtr<Aspose::Pdf::Engine::Presentation::IPresenter> Aspose::Pdf::Devices::ImageDevice::ProcessPresentation ( System::SharedPtr< Page page)
protected

processes current page and returns presenter

Parameters
page
Returns

◆ ProcessPresentation() [2/2]

System::SharedPtr<Aspose::Pdf::Engine::Presentation::IPresenter> Aspose::Pdf::Devices::ImageDevice::ProcessPresentation ( System::SharedPtr< Page page,
System::SharedPtr< System::Drawing::Graphics gr 
)
protected

processes current page with the graphics and returns presenter

Parameters
page
Returns

◆ set_CoordinateType()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Devices::ImageDevice::set_CoordinateType ( PageCoordinateType  value)

Sets the page coordinate type (Media/Crop boxes). CropBox value is used by default.

◆ set_FormPresentationMode()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Devices::ImageDevice::set_FormPresentationMode ( Aspose::Pdf::Devices::FormPresentationMode  value)

Sets form presentation mode.

◆ set_RenderingOptions()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Devices::ImageDevice::set_RenderingOptions ( System::SharedPtr< Aspose::Pdf::RenderingOptions value)

Sets rendering options.