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...

Inherits System::Object.

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

Public Member Functions

bool get_LinkDuplcateStreams ()
 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...
 
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...
 
bool get_AllowReusePageContent ()
 If true page contents will be reused when document is optimized for equal pages. More...
 
void set_AllowReusePageContent (bool value)
 If true page contents will be reused when document is optimized for equal pages. More...
 
bool get_RemoveUnusedStreams ()
 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...
 
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...
 
bool get_RemoveUnusedObjects ()
 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...
 
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...
 
System::SharedPtr< Aspose::Pdf::Optimization::ImageCompressionOptionsget_ImageCompressionOptions ()
 Set of options which describe will images in the document be compressed and parameters of the compression. More...
 
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...
 
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...
 
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...
 
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...
 
int32_t get_ImageQuality ()
 Specifies level of image compression when CompressIamges flag is used. More...
 
void set_ImageQuality (int32_t value)
 Specifies level of image compression when CompressIamges flag is used. More...
 
int32_t get_MaxResoultion ()
 Specifies maximum resolution of images. If image has higher resolition it will be scaled More...
 
void set_MaxResoultion (int32_t value)
 Specifies maximum resolution of images. If image has higher resolition it will be scaled More...
 
bool get_UnembedFonts ()
 Make fonts not embedded if set to true. More...
 
void set_UnembedFonts (bool value)
 Make fonts not embedded if set to true. More...
 
bool get_RemovePrivateInfo ()
 Remove private information (page piece info). More...
 
void set_RemovePrivateInfo (bool value)
 Remove private information (page piece info). More...
 
Aspose::Pdf::Optimization::ImageEncoding get_ImageEncoding ()
 Image encodre which will be used. More...
 
void set_ImageEncoding (Aspose::Pdf::Optimization::ImageEncoding value)
 Image encodre which will be used. More...
 
 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Static Public Member Functions

static System::SharedPtr< OptimizationOptionsAll ()
 Creates optimization strategy will all options activated. 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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::Optimization::OptimizationOptions::OptimizationOptions ( )

Member Function Documentation

◆ All()

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

Creates optimization strategy will all options activated.

Returns
OptimizationOptions object.

◆ get_AllowReusePageContent()

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

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

◆ get_CompressImages()

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.

◆ get_ImageCompressionOptions()

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

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

◆ get_ImageEncoding()

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

Image encodre which will be used.

◆ get_ImageQuality()

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

Specifies level of image compression when CompressIamges flag is used.

◆ get_LinkDuplcateStreams()

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

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()

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()

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

Remove private information (page piece info).

◆ get_RemoveUnusedObjects()

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

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()

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

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()

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.

◆ get_UnembedFonts()

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

Make fonts not embedded if set to true.

◆ set_AllowReusePageContent()

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()

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.

◆ set_ImageEncoding()

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

Image encodre which will be used.

◆ set_ImageQuality()

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

Specifies level of image compression when CompressIamges flag is used.

◆ set_LinkDuplcateStreams()

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()

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()

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

Remove private information (page piece info).

◆ set_RemoveUnusedObjects()

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()

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()

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.

◆ set_UnembedFonts()

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

Make fonts not embedded if set to true.