Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions Class Reference

Class for XPS-as-PDF saving options. More...

Inherits Aspose::Page::SaveOptions, and Aspose::Page::IMultiPageSaveOptions.

Public Member Functions

ASPOSE_PAGE_SHARED_API System::ArrayPtr< int32_t > get_PageNumbers () override
 Gets/sets the array of numbers of pages to convert. More...
 
ASPOSE_PAGE_SHARED_API void set_PageNumbers (System::ArrayPtr< int32_t > value) override
 Gets/sets the array of numbers of pages to convert. More...
 
ASPOSE_PAGE_SHARED_API int32_t get_OutlineTreeHeight () const
 Specifies the height of the document outline tree to save. 0 - the outline tree will not be converted, 1 - only the first level outline items will be converted, ans so on. More...
 
ASPOSE_PAGE_SHARED_API void set_OutlineTreeHeight (int32_t value)
 Specifies the height of the document outline tree to save. 0 - the outline tree will not be converted, 1 - only the first level outline items will be converted, ans so on. More...
 
ASPOSE_PAGE_SHARED_API int32_t get_OutlineTreeExpansionLevel () const
 Specifies up to what level the document outline should be expanded when the PDF file is viewed. 1 - only the first level outline items are shown, 2 - only the first and second level outline items are shown, and so on. Default is 1. More...
 
ASPOSE_PAGE_SHARED_API void set_OutlineTreeExpansionLevel (int32_t value)
 Specifies up to what level the document outline should be expanded when the PDF file is viewed. 1 - only the first level outline items are shown, 2 - only the first and second level outline items are shown, and so on. Default is 1. More...
 
ASPOSE_PAGE_SHARED_API PdfTextCompression get_TextCompression () const
 Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on. Default is 0. More...
 
ASPOSE_PAGE_SHARED_API void set_TextCompression (PdfTextCompression value)
 Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on. Default is 0. More...
 
ASPOSE_PAGE_SHARED_API PdfImageCompression get_ImageCompression () const
 Specifies compression type to be used for all images in the document. Default is PdfImageCompression::Auto. More...
 
ASPOSE_PAGE_SHARED_API void set_ImageCompression (PdfImageCompression value)
 Specifies compression type to be used for all images in the document. Default is PdfImageCompression::Auto. More...
 
ASPOSE_PAGE_SHARED_API System::SharedPtr< PdfEncryptionDetailsget_EncryptionDetails () const
 Gets a encryption details. If not set, then no encryption will be performed. More...
 
ASPOSE_PAGE_SHARED_API void set_EncryptionDetails (System::SharedPtr< PdfEncryptionDetails > value)
 Sets a encryption details. If not set, then no encryption will be performed. More...
 
ASPOSE_PAGE_SHARED_API PdfSaveOptions ()
 Creates new instance of options. More...
 
- Public Member Functions inherited from Aspose::Page::SaveOptions
virtual ASPOSE_PAGE_SHARED_API bool get_SupressErrors ()
 Specifies whether errors must be suppressed or not. If true suppressed errors are added to Exceptions list. If false the first error will terminate the program. More...
 
virtual ASPOSE_PAGE_SHARED_API void set_SupressErrors (bool value)
 Specifies whether errors must be suppressed or not. If true suppressed errors are added to Exceptions list. If false the first error will terminate the program. More...
 
virtual ASPOSE_PAGE_SHARED_API System::SharedPtr< System::Collections::Generic::IList< System::Exception > > get_Exceptions ()
 Returns a list of suppressed conversion errors If SuppressErrors is true. More...
 
virtual ASPOSE_PAGE_SHARED_API bool get_Debug ()
 Specifies whether debug information must be printed to standard output stream or not. More...
 
virtual ASPOSE_PAGE_SHARED_API void set_Debug (bool value)
 Specifies whether debug information must be printed to standard output stream or not. More...
 
ASPOSE_PAGE_SHARED_API System::ArrayPtr< System::Stringget_AdditionalFontsFolders () const
 Specifies additional folders where converter should find fonts for input document. Default folder are standard fonts folder where OS finds fonts for internal needs. More...
 
ASPOSE_PAGE_SHARED_API void set_AdditionalFontsFolders (System::ArrayPtr< System::String > value)
 Specifies additional folders where converter should find fonts for input document. Default folder are standard fonts folder where OS finds fonts for internal needs. More...
 
ASPOSE_PAGE_SHARED_API int32_t get_JpegQualityLevel () const
 The Quality category specifies the level of compression for an image. Available values are 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. 0 value results in lowest quality image, while 100 results in highest. More...
 
ASPOSE_PAGE_SHARED_API void set_JpegQualityLevel (int32_t value)
 The Quality category specifies the level of compression for an image. Available values are 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. 0 value results in lowest quality image, while 100 results in highest. More...
 
ASPOSE_PAGE_SHARED_API SaveOptions ()
 Initializes a new instance of the SaveOptions class with default values for flags SuppressErrors (true) and Debug (false). More...
 
ASPOSE_PAGE_SHARED_API SaveOptions (bool supressErrors)
 Initializes a new instance of the SaveOptions class with default value for flag Debug (false). 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)
 
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)
 

Protected Member Functions

PdfCompliance get_Compliance () const
 A debug settings that turns on display of active rectangles of hyperlinks in the PDF document. More...
 
void set_Compliance (PdfCompliance value)
 A debug settings that turns on display of active rectangles of hyperlinks in the PDF document. More...
 
System::SharedPtr< PdfDigitalSignatureDetailsget_DigitalSignatureDetails () const
 Gets a digital signature details. If not set, then no signing will be performed. More...
 
void set_DigitalSignatureDetails (System::SharedPtr< PdfDigitalSignatureDetails > value)
 Sets a digital signature details. If not set, then no signing will be performed. More...
 
System::SharedPtr< Aspose::Rendering::Pdf::PdfOptionsCore > ToCore ()
 

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

Class for XPS-as-PDF saving options.

Constructor & Destructor Documentation

◆ PdfSaveOptions()

ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::PdfSaveOptions ( )

Creates new instance of options.

Member Function Documentation

◆ get_Compliance()

PdfCompliance Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::get_Compliance ( ) const
protected

A debug settings that turns on display of active rectangles of hyperlinks in the PDF document.

Desired conformance level for generated PDF document. Important note: This option should not be changed after PdfDocument object is constructed. Default is PdfCompliance::Pdf15.

◆ get_DigitalSignatureDetails()

System::SharedPtr<PdfDigitalSignatureDetails> Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::get_DigitalSignatureDetails ( ) const
protected

Gets a digital signature details. If not set, then no signing will be performed.

◆ get_EncryptionDetails()

ASPOSE_PAGE_SHARED_API System::SharedPtr<PdfEncryptionDetails> Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::get_EncryptionDetails ( ) const

Gets a encryption details. If not set, then no encryption will be performed.

◆ get_ImageCompression()

ASPOSE_PAGE_SHARED_API PdfImageCompression Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::get_ImageCompression ( ) const

Specifies compression type to be used for all images in the document. Default is PdfImageCompression::Auto.

◆ get_OutlineTreeExpansionLevel()

ASPOSE_PAGE_SHARED_API int32_t Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::get_OutlineTreeExpansionLevel ( ) const

Specifies up to what level the document outline should be expanded when the PDF file is viewed. 1 - only the first level outline items are shown, 2 - only the first and second level outline items are shown, and so on. Default is 1.

◆ get_OutlineTreeHeight()

ASPOSE_PAGE_SHARED_API int32_t Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::get_OutlineTreeHeight ( ) const

Specifies the height of the document outline tree to save. 0 - the outline tree will not be converted, 1 - only the first level outline items will be converted, ans so on.

◆ get_PageNumbers()

ASPOSE_PAGE_SHARED_API System::ArrayPtr<int32_t> Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::get_PageNumbers ( )
overridevirtual

Gets/sets the array of numbers of pages to convert.

Implements Aspose::Page::IMultiPageSaveOptions.

◆ get_TextCompression()

ASPOSE_PAGE_SHARED_API PdfTextCompression Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::get_TextCompression ( ) const

Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on. Default is 0.

Specifies compression type to be used for all content streams except images. Default is PdfTextCompression::Flate.

◆ set_Compliance()

void Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::set_Compliance ( PdfCompliance  value)
protected

A debug settings that turns on display of active rectangles of hyperlinks in the PDF document.

Desired conformance level for generated PDF document. Important note: This option should not be changed after PdfDocument object is constructed. Default is PdfCompliance::Pdf15.

◆ set_DigitalSignatureDetails()

void Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::set_DigitalSignatureDetails ( System::SharedPtr< PdfDigitalSignatureDetails value)
protected

Sets a digital signature details. If not set, then no signing will be performed.

◆ set_EncryptionDetails()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::set_EncryptionDetails ( System::SharedPtr< PdfEncryptionDetails value)

Sets a encryption details. If not set, then no encryption will be performed.

◆ set_ImageCompression()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::set_ImageCompression ( PdfImageCompression  value)

Specifies compression type to be used for all images in the document. Default is PdfImageCompression::Auto.

◆ set_OutlineTreeExpansionLevel()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::set_OutlineTreeExpansionLevel ( int32_t  value)

Specifies up to what level the document outline should be expanded when the PDF file is viewed. 1 - only the first level outline items are shown, 2 - only the first and second level outline items are shown, and so on. Default is 1.

◆ set_OutlineTreeHeight()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::set_OutlineTreeHeight ( int32_t  value)

Specifies the height of the document outline tree to save. 0 - the outline tree will not be converted, 1 - only the first level outline items will be converted, ans so on.

◆ set_PageNumbers()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::set_PageNumbers ( System::ArrayPtr< int32_t >  value)
overridevirtual

Gets/sets the array of numbers of pages to convert.

Implements Aspose::Page::IMultiPageSaveOptions.

◆ set_TextCompression()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::set_TextCompression ( PdfTextCompression  value)

Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on. Default is 0.

Specifies compression type to be used for all content streams except images. Default is PdfTextCompression::Flate.

◆ ToCore()

System::SharedPtr<Aspose::Rendering::Pdf::PdfOptionsCore> Aspose::Page::XPS::Presentation::Pdf::PdfSaveOptions::ToCore ( )
protected