Aspose::Pdf::Devices::TiffSettings Class Referencefinal

This class represents settings for importing pdf to Tiff. More...

#include "TiffSettings.h"

Inherits System::Object.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Devices::Marginsget_Margins () const
 Gets the margins. More...
 
ASPOSE_PDF_SHARED_API bool get_SkipBlankPages () const
 Gets a value indicating whether to skip blank pages. More...
 
ASPOSE_PDF_SHARED_API void set_SkipBlankPages (bool value)
 Sets a value indicating whether to skip blank pages. More...
 
ASPOSE_PDF_SHARED_API CompressionType get_Compression () const
 Gets the type of the compression. More...
 
ASPOSE_PDF_SHARED_API void set_Compression (CompressionType value)
 Sets the type of the compression. More...
 
ASPOSE_PDF_SHARED_API ColorDepth get_Depth () const
 Gets the color depth. More...
 
ASPOSE_PDF_SHARED_API void set_Depth (ColorDepth value)
 Sets the color depth. More...
 
ASPOSE_PDF_SHARED_API ShapeType get_Shape () const
 Gets the type of the shape. More...
 
ASPOSE_PDF_SHARED_API void set_Shape (ShapeType value)
 Sets the type of the shape. More...
 
ASPOSE_PDF_SHARED_API float get_Brightness () const
 Get or sets a value boundary of the transformation of colors in white and black. This parameter can be applied with EncoderValue.CompressionCCITT4, EncoderValue.CompressionCCITT3, EncoderValue.CompressionRle or ColorDepth.Format1bpp == 1 More...
 
ASPOSE_PDF_SHARED_API void set_Brightness (float value)
 Get or sets a value boundary of the transformation of colors in white and black. This parameter can be applied with EncoderValue.CompressionCCITT4, EncoderValue.CompressionCCITT3, EncoderValue.CompressionRle or ColorDepth.Format1bpp == 1 More...
 
ASPOSE_PDF_SHARED_API PageCoordinateType get_CoordinateType () const
 Get or sets the page coordinate type (Media/Crop boxes). CropBox value is used by default. More...
 
ASPOSE_PDF_SHARED_API void set_CoordinateType (PageCoordinateType value)
 Get or sets the page coordinate type (Media/Crop boxes). CropBox value is used by default. More...
 
ASPOSE_PDF_SHARED_API TiffSettings ()
 Initializes a new instance of the TiffSettings class. More...
 
ASPOSE_PDF_SHARED_API TiffSettings (ShapeType shapeType)
 Initializes a new instance of the TiffSettings class. More...
 
ASPOSE_PDF_SHARED_API TiffSettings (CompressionType compressionType)
 Initializes a new instance of the TiffSettings class. More...
 
ASPOSE_PDF_SHARED_API TiffSettings (ColorDepth colorDepth)
 Initializes a new instance of the TiffSettings class. More...
 
ASPOSE_PDF_SHARED_API TiffSettings (System::SharedPtr< Aspose::Pdf::Devices::Margins > margins)
 Initializes a new instance of the TiffSettings class. More...
 
ASPOSE_PDF_SHARED_API TiffSettings (CompressionType compressionType, ColorDepth colorDepth, System::SharedPtr< Aspose::Pdf::Devices::Margins > margins)
 Initializes a new instance of the TiffSettings class. More...
 
ASPOSE_PDF_SHARED_API TiffSettings (CompressionType compressionType, ColorDepth colorDepth, System::SharedPtr< Aspose::Pdf::Devices::Margins > margins, bool skipBlankPages)
 Initializes a new instance of the TiffSettings class. More...
 
ASPOSE_PDF_SHARED_API TiffSettings (CompressionType compressionType, ColorDepth colorDepth, System::SharedPtr< Aspose::Pdf::Devices::Margins > margins, bool skipBlankPages, ShapeType shapeType)
 Initializes a new instance of the TiffSettings class. More...
 
ASPOSE_PDF_SHARED_API TiffSettings (bool skipBlankPages)
 Initializes a new instance of the TiffSettings class. 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

- 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

This class represents settings for importing pdf to Tiff.

Constructor & Destructor Documentation

◆ TiffSettings() [1/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::TiffSettings::TiffSettings ( )

Initializes a new instance of the TiffSettings class.

◆ TiffSettings() [2/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::TiffSettings::TiffSettings ( ShapeType  shapeType)

Initializes a new instance of the TiffSettings class.

Parameters
shapeTypeType of the shape.

◆ TiffSettings() [3/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::TiffSettings::TiffSettings ( CompressionType  compressionType)

Initializes a new instance of the TiffSettings class.

Parameters
compressionTypeType of the compression.

◆ TiffSettings() [4/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::TiffSettings::TiffSettings ( ColorDepth  colorDepth)

Initializes a new instance of the TiffSettings class.

Parameters
colorDepthThe color depth.

◆ TiffSettings() [5/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::TiffSettings::TiffSettings ( System::SharedPtr< Aspose::Pdf::Devices::Margins margins)

Initializes a new instance of the TiffSettings class.

Parameters
marginsThe margins.

◆ TiffSettings() [6/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::TiffSettings::TiffSettings ( CompressionType  compressionType,
ColorDepth  colorDepth,
System::SharedPtr< Aspose::Pdf::Devices::Margins margins 
)

Initializes a new instance of the TiffSettings class.

Parameters
compressionTypeType of the compression.
colorDepthThe color depth.
marginsThe margins.

◆ TiffSettings() [7/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::TiffSettings::TiffSettings ( CompressionType  compressionType,
ColorDepth  colorDepth,
System::SharedPtr< Aspose::Pdf::Devices::Margins margins,
bool  skipBlankPages 
)

Initializes a new instance of the TiffSettings class.

Parameters
compressionTypeType of the compression.
colorDepthThe color depth.
marginsThe margins.
skipBlankPagesif set to true need to skip blank pages.

◆ TiffSettings() [8/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::TiffSettings::TiffSettings ( CompressionType  compressionType,
ColorDepth  colorDepth,
System::SharedPtr< Aspose::Pdf::Devices::Margins margins,
bool  skipBlankPages,
ShapeType  shapeType 
)

Initializes a new instance of the TiffSettings class.

Parameters
compressionTypeType of the compression.
colorDepthThe color depth.
marginsThe margins.
skipBlankPagesif set to true need to skip blank pages.
shapeTypeType of the shape.

◆ TiffSettings() [9/9]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Devices::TiffSettings::TiffSettings ( bool  skipBlankPages)

Initializes a new instance of the TiffSettings class.

Parameters
skipBlankPagesif set to true [skip blank pages].

Member Function Documentation

◆ get_Brightness()

ASPOSE_PDF_SHARED_API float Aspose::Pdf::Devices::TiffSettings::get_Brightness ( ) const

Get or sets a value boundary of the transformation of colors in white and black. This parameter can be applied with EncoderValue.CompressionCCITT4, EncoderValue.CompressionCCITT3, EncoderValue.CompressionRle or ColorDepth.Format1bpp == 1

Value of brightness should be in the range from 0 to 1. By default value is equal to 0.33f

◆ get_Compression()

ASPOSE_PDF_SHARED_API CompressionType Aspose::Pdf::Devices::TiffSettings::get_Compression ( ) const

Gets the type of the compression.

Default value is CompressionType.LZW

The type of the compression.

◆ get_CoordinateType()

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

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

◆ get_Depth()

ASPOSE_PDF_SHARED_API ColorDepth Aspose::Pdf::Devices::TiffSettings::get_Depth ( ) const

Gets the color depth.

Default value is ColorDepth.Default

The color depth.

◆ get_Margins()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Devices::Margins> Aspose::Pdf::Devices::TiffSettings::get_Margins ( ) const

Gets the margins.

◆ get_Shape()

ASPOSE_PDF_SHARED_API ShapeType Aspose::Pdf::Devices::TiffSettings::get_Shape ( ) const

Gets the type of the shape.

Default value is ShapeType.None

The type of the shape.

◆ get_SkipBlankPages()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Devices::TiffSettings::get_SkipBlankPages ( ) const

Gets a value indicating whether to skip blank pages.

Default value is false

true if need to skip blank pages; otherwise, false.

◆ set_Brightness()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Devices::TiffSettings::set_Brightness ( float  value)

Get or sets a value boundary of the transformation of colors in white and black. This parameter can be applied with EncoderValue.CompressionCCITT4, EncoderValue.CompressionCCITT3, EncoderValue.CompressionRle or ColorDepth.Format1bpp == 1

Value of brightness should be in the range from 0 to 1. By default value is equal to 0.33f

◆ set_Compression()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Devices::TiffSettings::set_Compression ( CompressionType  value)

Sets the type of the compression.

Default value is CompressionType.LZW

The type of the compression.

◆ set_CoordinateType()

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

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

◆ set_Depth()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Devices::TiffSettings::set_Depth ( ColorDepth  value)

Sets the color depth.

Default value is ColorDepth.Default

The color depth.

◆ set_Shape()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Devices::TiffSettings::set_Shape ( ShapeType  value)

Sets the type of the shape.

Default value is ShapeType.None

The type of the shape.

◆ set_SkipBlankPages()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Devices::TiffSettings::set_SkipBlankPages ( bool  value)

Sets a value indicating whether to skip blank pages.

Default value is false

true if need to skip blank pages; otherwise, false.