Aspose::Pdf::Optimization::OptimizationOptions Class Reference

Class which describes document optimization algorithm. Instance of this class may be used as parameter of OptimizeResources() method. More...

#include "OptimizationOptions.h"

Inherits System::Object.

Inherited by Aspose::Pdf::Document::OptimizationOptions.

Public Member Functions

ASPOSE_PDF_SHARED_API bool get_CompressObjects () const
 If this flag is set to , Pdf objects will be packed into Objest Streams and compressed to reduce pdf file size. More...
 
ASPOSE_PDF_SHARED_API void set_CompressObjects (bool value)
 If this flag is set to , Pdf objects will be packed into Objest Streams and compressed to reduce pdf file size. More...
 
ASPOSE_PDF_SHARED_API bool get_LinkDuplcateStreams () const
 If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thes streams will be stored as one object. This allows to decrease document size in some cases (for example, when same document was concatenedted multiple times). More...
 
ASPOSE_PDF_SHARED_API void set_LinkDuplcateStreams (bool value)
 If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thes streams will be stored as one object. This allows to decrease document size in some cases (for example, when same document was concatenedted multiple times). More...
 
ASPOSE_PDF_SHARED_API bool get_AllowReusePageContent () const
 If true page contents will be reused when document is optimized for equal pages. More...
 
ASPOSE_PDF_SHARED_API void set_AllowReusePageContent (bool value)
 If true page contents will be reused when document is optimized for equal pages. More...
 
ASPOSE_PDF_SHARED_API bool get_RemoveUnusedStreams () const
 If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document. More...
 
ASPOSE_PDF_SHARED_API void set_RemoveUnusedStreams (bool value)
 If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document. More...
 
ASPOSE_PDF_SHARED_API bool get_RemoveUnusedObjects () const
 If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document. More...
 
ASPOSE_PDF_SHARED_API void set_RemoveUnusedObjects (bool value)
 If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Optimization::ImageCompressionOptionsget_ImageCompressionOptions () const
 Set of options which describe will images in the document be compressed and parameters of the compression. More...
 
ASPOSE_PDF_SHARED_API bool get_CompressImages ()
 If this flag is set to true images will be compressed in the document. compression level is specfied with ImageQuality property. More...
 
ASPOSE_PDF_SHARED_API void set_CompressImages (bool value)
 If this flag is set to true images will be compressed in the document. compression level is specfied with ImageQuality property. More...
 
ASPOSE_PDF_SHARED_API bool get_ResizeImages ()
 If this flag set to true and CompressImages is true images will be resized if image resoultion is greater then specified MaxResolution parameter. More...
 
ASPOSE_PDF_SHARED_API void set_ResizeImages (bool value)
 If this flag set to true and CompressImages is true images will be resized if image resoultion is greater then specified MaxResolution parameter. More...
 
ASPOSE_PDF_SHARED_API int32_t get_ImageQuality ()
 Specifies level of image compression when CompressIamges flag is used. More...
 
ASPOSE_PDF_SHARED_API void set_ImageQuality (int32_t value)
 Specifies level of image compression when CompressIamges flag is used. More...
 
ASPOSE_PDF_SHARED_API int32_t get_MaxResoultion ()
 Specifies maximum resolution of images. If image has higher resolition it will be scaled More...
 
ASPOSE_PDF_SHARED_API void set_MaxResoultion (int32_t value)
 Specifies maximum resolution of images. If image has higher resolition it will be scaled More...
 
ASPOSE_PDF_SHARED_API bool get_UnembedFonts () const
 Make fonts not embedded if set to true. More...
 
ASPOSE_PDF_SHARED_API void set_UnembedFonts (bool value)
 Make fonts not embedded if set to true. More...
 
ASPOSE_PDF_SHARED_API bool get_SubsetFonts () const
 Fonts will be converted into subsets if set to true. More...
 
ASPOSE_PDF_SHARED_API void set_SubsetFonts (bool value)
 Fonts will be converted into subsets if set to true. More...
 
ASPOSE_PDF_SHARED_API bool get_RemovePrivateInfo () const
 Remove private information (page piece info). More...
 
ASPOSE_PDF_SHARED_API void set_RemovePrivateInfo (bool value)
 Remove private information (page piece info). More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::Optimization::ImageEncoding get_ImageEncoding () const
 Image encodre which will be used. More...
 
ASPOSE_PDF_SHARED_API void set_ImageEncoding (Aspose::Pdf::Optimization::ImageEncoding value)
 Image encodre which will be used. More...
 
ASPOSE_PDF_SHARED_API OptimizationOptions ()
 
- 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...
 

Static Public Member Functions

static ASPOSE_PDF_SHARED_API System::SharedPtr< OptimizationOptionsAll ()
 Creates optimization strategy will all options activated. Please note that activated only options which does not change any functionality of the document. I.e. image compressing and fonts unembedding will not enabled (and can be embedded manually). 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...
 

Additional Inherited Members

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

Detailed Description

Class which describes document optimization algorithm. Instance of this class may be used as parameter of OptimizeResources() method.

Constructor & Destructor Documentation

◆ OptimizationOptions()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Optimization::OptimizationOptions::OptimizationOptions ( )

Member Function Documentation

◆ All()

static ASPOSE_PDF_SHARED_API System::SharedPtr<OptimizationOptions> Aspose::Pdf::Optimization::OptimizationOptions::All ( )
static

Creates optimization strategy will all options activated. Please note that activated only options which does not change any functionality of the document. I.e. image compressing and fonts unembedding will not enabled (and can be embedded manually).

Returns
OptimizationOptions object.

◆ get_AllowReusePageContent()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Optimization::OptimizationOptions::get_AllowReusePageContent ( ) const

If true page contents will be reused when document is optimized for equal pages.

◆ get_CompressImages()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Optimization::OptimizationOptions::get_CompressImages ( )

If this flag is set to true images will be compressed in the document. compression level is specfied with ImageQuality property.

Deprecated:
Please use ImageCompressionOptions.CompressImages instead.

◆ get_CompressObjects()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Optimization::OptimizationOptions::get_CompressObjects ( ) const

If this flag is set to , Pdf objects will be packed into Objest Streams and compressed to reduce pdf file size.

◆ get_ImageCompressionOptions()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Optimization::ImageCompressionOptions> Aspose::Pdf::Optimization::OptimizationOptions::get_ImageCompressionOptions ( ) const

Set of options which describe will images in the document be compressed and parameters of the compression.

◆ get_ImageEncoding()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Optimization::ImageEncoding Aspose::Pdf::Optimization::OptimizationOptions::get_ImageEncoding ( ) const

Image encodre which will be used.

◆ get_ImageQuality()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Optimization::OptimizationOptions::get_ImageQuality ( )

Specifies level of image compression when CompressIamges flag is used.

Deprecated:
Please use ImageCompressionOptions.ImageQuality instead.

◆ get_LinkDuplcateStreams()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Optimization::OptimizationOptions::get_LinkDuplcateStreams ( ) const

If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thes streams will be stored as one object. This allows to decrease document size in some cases (for example, when same document was concatenedted multiple times).

◆ get_MaxResoultion()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Optimization::OptimizationOptions::get_MaxResoultion ( )

Specifies maximum resolution of images. If image has higher resolition it will be scaled

[Obsolete("Please use ImageCompressionOptions.MaxResolution instead.")]

◆ get_RemovePrivateInfo()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Optimization::OptimizationOptions::get_RemovePrivateInfo ( ) const

Remove private information (page piece info).

◆ get_RemoveUnusedObjects()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Optimization::OptimizationOptions::get_RemoveUnusedObjects ( ) const

If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document.

◆ get_RemoveUnusedStreams()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Optimization::OptimizationOptions::get_RemoveUnusedStreams ( ) const

If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document.

◆ get_ResizeImages()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Optimization::OptimizationOptions::get_ResizeImages ( )

If this flag set to true and CompressImages is true images will be resized if image resoultion is greater then specified MaxResolution parameter.

Deprecated:
Please use ImageCompressionOptions.ResizeImages instead.

◆ get_SubsetFonts()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Optimization::OptimizationOptions::get_SubsetFonts ( ) const

Fonts will be converted into subsets if set to true.

◆ get_UnembedFonts()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Optimization::OptimizationOptions::get_UnembedFonts ( ) const

Make fonts not embedded if set to true.

◆ set_AllowReusePageContent()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_AllowReusePageContent ( bool  value)

If true page contents will be reused when document is optimized for equal pages.

◆ set_CompressImages()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_CompressImages ( bool  value)

If this flag is set to true images will be compressed in the document. compression level is specfied with ImageQuality property.

Deprecated:
Please use ImageCompressionOptions.CompressImages instead.

◆ set_CompressObjects()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_CompressObjects ( bool  value)

If this flag is set to , Pdf objects will be packed into Objest Streams and compressed to reduce pdf file size.

◆ set_ImageEncoding()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_ImageEncoding ( Aspose::Pdf::Optimization::ImageEncoding  value)

Image encodre which will be used.

◆ set_ImageQuality()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_ImageQuality ( int32_t  value)

Specifies level of image compression when CompressIamges flag is used.

Deprecated:
Please use ImageCompressionOptions.ImageQuality instead.

◆ set_LinkDuplcateStreams()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_LinkDuplcateStreams ( bool  value)

If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thes streams will be stored as one object. This allows to decrease document size in some cases (for example, when same document was concatenedted multiple times).

◆ set_MaxResoultion()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_MaxResoultion ( int32_t  value)

Specifies maximum resolution of images. If image has higher resolition it will be scaled

[Obsolete("Please use ImageCompressionOptions.MaxResolution instead.")]

◆ set_RemovePrivateInfo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_RemovePrivateInfo ( bool  value)

Remove private information (page piece info).

◆ set_RemoveUnusedObjects()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_RemoveUnusedObjects ( bool  value)

If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document.

◆ set_RemoveUnusedStreams()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_RemoveUnusedStreams ( bool  value)

If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document.

◆ set_ResizeImages()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_ResizeImages ( bool  value)

If this flag set to true and CompressImages is true images will be resized if image resoultion is greater then specified MaxResolution parameter.

Deprecated:
Please use ImageCompressionOptions.ResizeImages instead.

◆ set_SubsetFonts()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_SubsetFonts ( bool  value)

Fonts will be converted into subsets if set to true.

◆ set_UnembedFonts()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Optimization::OptimizationOptions::set_UnembedFonts ( bool  value)

Make fonts not embedded if set to true.