Aspose::Pdf::RenderingOptions Class Referencefinal

Represents rendering options. More...

#include "RenderingOptions.h"

Inherits System::Object.

Public Member Functions

ASPOSE_PDF_SHARED_API bool get_BarcodeOptimization () const
 Gets barcode optimization mode. More...
 
ASPOSE_PDF_SHARED_API void set_BarcodeOptimization (bool value)
 Sets barcode optimization mode. More...
 
ASPOSE_PDF_SHARED_API bool get_OptimizeDimensions () const
 Gets optimize dimensions mode. More...
 
ASPOSE_PDF_SHARED_API void set_OptimizeDimensions (bool value)
 Sets optimize dimensions mode. More...
 
ASPOSE_PDF_SHARED_API bool get_SystemFontsNativeRendering () const
 Gets a mode where system fonts are rendered natively. More...
 
ASPOSE_PDF_SHARED_API void set_SystemFontsNativeRendering (bool value)
 Sets a mode where system fonts are rendered natively. More...
 
ASPOSE_PDF_SHARED_API bool get_UseNewImagingEngine () const
 Gets a flag determines whether new imaging engine is used or not. More...
 
ASPOSE_PDF_SHARED_API void set_UseNewImagingEngine (bool value)
 Sets a flag determines whether new imaging engine is used or not. More...
 
ASPOSE_PDF_SHARED_API float get_WidthExtraUnits () const
 Gets a value used to increase or decrease the width of rectangle for AppendRectangle operator. More...
 
ASPOSE_PDF_SHARED_API void set_WidthExtraUnits (float value)
 Sets a value used to increase or decrease the width of rectangle for AppendRectangle operator. More...
 
ASPOSE_PDF_SHARED_API float get_HeightExtraUnits () const
 Gets a value used to increase or decrease the width of rectangle for AppendRectangle operator. More...
 
ASPOSE_PDF_SHARED_API void set_HeightExtraUnits (float value)
 Sets a value used to increase or decrease the width of rectangle for AppendRectangle operator. More...
 
ASPOSE_PDF_SHARED_API bool get_ConvertFontsToUnicodeTTF () const
 Indicates that all fonts will be converted to TTF unicode versions. That is useful for compatibility reasons and to optimize font usage, cause every new TTF font will have not all the symbols from source font, but only symbols which are used in text. More...
 
ASPOSE_PDF_SHARED_API void set_ConvertFontsToUnicodeTTF (bool value)
 Indicates that all fonts will be converted to TTF unicode versions. That is useful for compatibility reasons and to optimize font usage, cause every new TTF font will have not all the symbols from source font, but only symbols which are used in text. More...
 
ASPOSE_PDF_SHARED_API bool get_UseFontHinting () const
 Usage of this flag turn on font hinting mechanism. Font hinting is the use of mathematical instructions to adjust the display of an outline font. In some cases turning this flag on may solve problems with text legibility. At current moment usage of this flag could give effect only for TTF fonts, if these fonts are used in source document. More...
 
ASPOSE_PDF_SHARED_API void set_UseFontHinting (bool value)
 Usage of this flag turn on font hinting mechanism. Font hinting is the use of mathematical instructions to adjust the display of an outline font. In some cases turning this flag on may solve problems with text legibility. At current moment usage of this flag could give effect only for TTF fonts, if these fonts are used in source document. More...
 
ASPOSE_PDF_SHARED_API bool get_ScaleImagesToFitPageWidth () const
 Gets a values used to scale all images on the page to fit page's width. More...
 
ASPOSE_PDF_SHARED_API void set_ScaleImagesToFitPageWidth (bool value)
 Sets a values used to scale all images on the page to fit page's width. More...
 
ASPOSE_PDF_SHARED_API bool get_InterpolationHighQuality () const
 Gets hiqh quality mode for interpolation. More...
 
ASPOSE_PDF_SHARED_API void set_InterpolationHighQuality (bool value)
 Sets hiqh quality mode for interpolation. More...
 
ASPOSE_PDF_SHARED_API int32_t get_MaxFontsCacheSize () const
 Maximum count of fonts in fonts cache. Default value is 10. More...
 
ASPOSE_PDF_SHARED_API void set_MaxFontsCacheSize (int32_t value)
 Maximum count of fonts in fonts cache. Default value is 10. More...
 
ASPOSE_PDF_SHARED_API int32_t get_MaxSymbolsCacheSize () const
 Maximum count of symbols in symbol cache. Default value is 100. More...
 
ASPOSE_PDF_SHARED_API void set_MaxSymbolsCacheSize (int32_t value)
 Maximum count of symbols in symbol cache. Default value is 100. More...
 
ASPOSE_PDF_SHARED_API System::String get_DefaultFontName () const
 Gets/sets the default name of font used to substitute of missing fonts. More...
 
ASPOSE_PDF_SHARED_API void set_DefaultFontName (System::String value)
 Gets/sets the default name of font used to substitute of missing fonts. More...
 
ASPOSE_PDF_SHARED_API bool get_IgnoreResourceFontErrors () const
 Gets indication that errors related to absence of font will be ignored. true - means that errors of absence of font will be ignored. Text segments that refer to incorrect resources will be skipped during processing. false by default More...
 
ASPOSE_PDF_SHARED_API void set_IgnoreResourceFontErrors (bool value)
 Sets indication that errors related to absence of font will be ignored. true - means that errors of absence of font will be ignored. Text segments that refer to incorrect resources will be skipped during processing. false by default More...
 
ASPOSE_PDF_SHARED_API RenderingOptions ()
 Initializes new instance of the RenderingOptions object. 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

bool get_Use24bppBitmap () const
 Gets bitmap type, if it's false, 32bppArgb will be used. More...
 
void set_Use24bppBitmap (bool value)
 Sets bitmap type, if it's false, 32bppArgb will be used. 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

Represents rendering options.

Constructor & Destructor Documentation

◆ RenderingOptions()

ASPOSE_PDF_SHARED_API Aspose::Pdf::RenderingOptions::RenderingOptions ( )

Initializes new instance of the RenderingOptions object.

Member Function Documentation

◆ get_BarcodeOptimization()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::RenderingOptions::get_BarcodeOptimization ( ) const

Gets barcode optimization mode.

◆ get_ConvertFontsToUnicodeTTF()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::RenderingOptions::get_ConvertFontsToUnicodeTTF ( ) const

Indicates that all fonts will be converted to TTF unicode versions. That is useful for compatibility reasons and to optimize font usage, cause every new TTF font will have not all the symbols from source font, but only symbols which are used in text.

◆ get_DefaultFontName()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::RenderingOptions::get_DefaultFontName ( ) const

Gets/sets the default name of font used to substitute of missing fonts.

◆ get_HeightExtraUnits()

ASPOSE_PDF_SHARED_API float Aspose::Pdf::RenderingOptions::get_HeightExtraUnits ( ) const

Gets a value used to increase or decrease the width of rectangle for AppendRectangle operator.

◆ get_IgnoreResourceFontErrors()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::RenderingOptions::get_IgnoreResourceFontErrors ( ) const

Gets indication that errors related to absence of font will be ignored. true - means that errors of absence of font will be ignored. Text segments that refer to incorrect resources will be skipped during processing. false by default

◆ get_InterpolationHighQuality()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::RenderingOptions::get_InterpolationHighQuality ( ) const

Gets hiqh quality mode for interpolation.

◆ get_MaxFontsCacheSize()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::RenderingOptions::get_MaxFontsCacheSize ( ) const

Maximum count of fonts in fonts cache. Default value is 10.

◆ get_MaxSymbolsCacheSize()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::RenderingOptions::get_MaxSymbolsCacheSize ( ) const

Maximum count of symbols in symbol cache. Default value is 100.

◆ get_OptimizeDimensions()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::RenderingOptions::get_OptimizeDimensions ( ) const

Gets optimize dimensions mode.

◆ get_ScaleImagesToFitPageWidth()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::RenderingOptions::get_ScaleImagesToFitPageWidth ( ) const

Gets a values used to scale all images on the page to fit page's width.

Deprecated:
ScaleImagesToFitPageWidth is deprecated.

◆ get_SystemFontsNativeRendering()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::RenderingOptions::get_SystemFontsNativeRendering ( ) const

Gets a mode where system fonts are rendered natively.

◆ get_Use24bppBitmap()

bool Aspose::Pdf::RenderingOptions::get_Use24bppBitmap ( ) const
protected

Gets bitmap type, if it's false, 32bppArgb will be used.

◆ get_UseFontHinting()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::RenderingOptions::get_UseFontHinting ( ) const

Usage of this flag turn on font hinting mechanism. Font hinting is the use of mathematical instructions to adjust the display of an outline font. In some cases turning this flag on may solve problems with text legibility. At current moment usage of this flag could give effect only for TTF fonts, if these fonts are used in source document.

◆ get_UseNewImagingEngine()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::RenderingOptions::get_UseNewImagingEngine ( ) const

Gets a flag determines whether new imaging engine is used or not.

Deprecated:
UseNewImagingEngine is deprecated

◆ get_WidthExtraUnits()

ASPOSE_PDF_SHARED_API float Aspose::Pdf::RenderingOptions::get_WidthExtraUnits ( ) const

Gets a value used to increase or decrease the width of rectangle for AppendRectangle operator.

◆ set_BarcodeOptimization()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_BarcodeOptimization ( bool  value)

Sets barcode optimization mode.

◆ set_ConvertFontsToUnicodeTTF()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_ConvertFontsToUnicodeTTF ( bool  value)

Indicates that all fonts will be converted to TTF unicode versions. That is useful for compatibility reasons and to optimize font usage, cause every new TTF font will have not all the symbols from source font, but only symbols which are used in text.

◆ set_DefaultFontName()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_DefaultFontName ( System::String  value)

Gets/sets the default name of font used to substitute of missing fonts.

◆ set_HeightExtraUnits()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_HeightExtraUnits ( float  value)

Sets a value used to increase or decrease the width of rectangle for AppendRectangle operator.

◆ set_IgnoreResourceFontErrors()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_IgnoreResourceFontErrors ( bool  value)

Sets indication that errors related to absence of font will be ignored. true - means that errors of absence of font will be ignored. Text segments that refer to incorrect resources will be skipped during processing. false by default

◆ set_InterpolationHighQuality()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_InterpolationHighQuality ( bool  value)

Sets hiqh quality mode for interpolation.

◆ set_MaxFontsCacheSize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_MaxFontsCacheSize ( int32_t  value)

Maximum count of fonts in fonts cache. Default value is 10.

◆ set_MaxSymbolsCacheSize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_MaxSymbolsCacheSize ( int32_t  value)

Maximum count of symbols in symbol cache. Default value is 100.

◆ set_OptimizeDimensions()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_OptimizeDimensions ( bool  value)

Sets optimize dimensions mode.

◆ set_ScaleImagesToFitPageWidth()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_ScaleImagesToFitPageWidth ( bool  value)

Sets a values used to scale all images on the page to fit page's width.

Deprecated:
ScaleImagesToFitPageWidth is deprecated.

◆ set_SystemFontsNativeRendering()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_SystemFontsNativeRendering ( bool  value)

Sets a mode where system fonts are rendered natively.

◆ set_Use24bppBitmap()

void Aspose::Pdf::RenderingOptions::set_Use24bppBitmap ( bool  value)
protected

Sets bitmap type, if it's false, 32bppArgb will be used.

◆ set_UseFontHinting()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_UseFontHinting ( bool  value)

Usage of this flag turn on font hinting mechanism. Font hinting is the use of mathematical instructions to adjust the display of an outline font. In some cases turning this flag on may solve problems with text legibility. At current moment usage of this flag could give effect only for TTF fonts, if these fonts are used in source document.

◆ set_UseNewImagingEngine()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_UseNewImagingEngine ( bool  value)

Sets a flag determines whether new imaging engine is used or not.

Deprecated:
UseNewImagingEngine is deprecated

◆ set_WidthExtraUnits()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::RenderingOptions::set_WidthExtraUnits ( float  value)

Sets a value used to increase or decrease the width of rectangle for AppendRectangle operator.