Aspose::Slides::Export::IPdfOptions Class Referenceabstract

Provides options that control how a presentation is saved in Pdf format. More...

Inherits Aspose::Slides::Export::ISaveOptions.

Inherited by Aspose::Slides::Export::PdfOptions.

Public Member Functions

virtual PdfTextCompression get_TextCompression ()=0
 Specifies compression type to be used for all textual content in the document. Read PdfTextCompression. More...
 
virtual void set_TextCompression (PdfTextCompression value)=0
 Specifies compression type to be used for all textual content in the document. Write PdfTextCompression. More...
 
virtual bool get_BestImagesCompressionRatio ()=0
 Indicates if the most effective compression (instead of the default one) for each image must be selected automatically. If set to bool::True, for every image in presentation the most appropriate compression algorithm will be chosen, what will lead to the smaller size of the resulting PDF document. More...
 
virtual void set_BestImagesCompressionRatio (bool value)=0
 Indicates if the most effective compression (instead of the default one) for each image must be selected automatically. If set to bool::True, for every image in presentation the most appropriate compression algorithm will be chosen, what will lead to the smaller size of the resulting PDF document. More...
 
virtual bool get_EmbedTrueTypeFontsForASCII ()=0
 True to embed true type fonts for ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Read bool. More...
 
virtual void set_EmbedTrueTypeFontsForASCII (bool value)=0
 True to embed true type fonts for ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Write bool. More...
 
virtual bool get_ShowHiddenSlides ()=0
 Specifies whether the generated document should include hidden slides or not. Default is false. More...
 
virtual void set_ShowHiddenSlides (bool value)=0
 Specifies whether the generated document should include hidden slides or not. Default is false. More...
 
virtual System::ArrayPtr< System::Stringget_AdditionalCommonFontFamilies ()=0
 Returns an array of user-defined names of font families which Aspose.Slides should consider common. Read System::ArrayPtr<System::String>. More...
 
virtual void set_AdditionalCommonFontFamilies (System::ArrayPtr< System::String > value)=0
 Sets an array of user-defined names of font families which Aspose.Slides should consider common. Write System::ArrayPtr<System::String>. More...
 
virtual bool get_EmbedFullFonts ()=0
 Determines if all characters of font should be embedded or only used subset. Read bool. More...
 
virtual void set_EmbedFullFonts (bool value)=0
 Determines if all characters of font should be embedded or only used subset. Write bool. More...
 
virtual uint8_t get_JpegQuality ()=0
 Returns a value determining the quality of the JPEG images inside PDF document. Read uint8_t. More...
 
virtual void set_JpegQuality (uint8_t value)=0
 Sets a value determining the quality of the JPEG images inside PDF document. Write uint8_t. More...
 
virtual PdfCompliance get_Compliance ()=0
 Desired conformance level for generated PDF document. Read PdfCompliance. More...
 
virtual void set_Compliance (PdfCompliance value)=0
 Desired conformance level for generated PDF document. Write PdfCompliance. More...
 
virtual System::String get_Password ()=0
 Setting user password to protect the PDF document. Read System::String. More...
 
virtual void set_Password (System::String value)=0
 Setting user password to protect the PDF document. Write System::String. More...
 
virtual PdfAccessPermissions get_AccessPermissions ()=0
 Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions. More...
 
virtual void set_AccessPermissions (PdfAccessPermissions value)=0
 Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions. More...
 
virtual bool get_SaveMetafilesAsPng ()=0
 True to convert all metafiles used in a presentation to the PNG images. Read bool. More...
 
virtual void set_SaveMetafilesAsPng (bool value)=0
 True to convert all metafiles used in a presentation to the PNG images. Write bool. More...
 
virtual float get_SufficientResolution ()=0
 Returns a value determining resolution of images inside PDF document. More...
 
virtual void set_SufficientResolution (float value)=0
 Sets a value determining resolution of images inside PDF document. More...
 
virtual bool get_DrawSlidesFrame ()=0
 True to draw black frame around each slide. Read bool. More...
 
virtual void set_DrawSlidesFrame (bool value)=0
 True to draw black frame around each slide. Write bool. More...
 
virtual System::SharedPtr< INotesCommentsLayoutingOptionsget_NotesCommentsLayouting ()=0
 Provides options that control how notes and comments is placed in exported document. More...
 
virtual System::Drawing::Color get_ImageTransparentColor ()=0
 Gets the image transparent color. More...
 
virtual void set_ImageTransparentColor (System::Drawing::Color value)=0
 Sets the image transparent color. More...
 
virtual bool get_ApplyImageTransparent ()=0
 Applies the specified transparent color to an image if true. More...
 
virtual void set_ApplyImageTransparent (bool value)=0
 Applies the specified transparent color to an image if true. More...
 
- Public Member Functions inherited from Aspose::Slides::Export::ISaveOptions
virtual System::SharedPtr< Aspose::Slides::Warnings::IWarningCallbackget_WarningCallback ()=0
 Returns an object which receives warnings and decides whether loading process will continue or will be aborted. Read IWarningCallback. More...
 
virtual void set_WarningCallback (System::SharedPtr< Aspose::Slides::Warnings::IWarningCallback > value)=0
 Sets an object which receives warnings and decides whether loading process will continue or will be aborted. Write IWarningCallback. More...
 
virtual System::SharedPtr< IProgressCallbackget_ProgressCallback ()=0
 Represents a callback object for saving progress updates in percentage. See IProgressCallback. More...
 
virtual void set_ProgressCallback (System::SharedPtr< IProgressCallback > value)=0
 Represents a callback object for saving progress updates in percentage. See IProgressCallback. More...
 
virtual System::String get_DefaultRegularFont ()=0
 Returns font used in case source font is not found. Read-write System::String. More...
 
virtual void set_DefaultRegularFont (System::String value)=0
 Sets font used in case source font is not found. Read-write System::String. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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)
 

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

Detailed Description

Provides options that control how a presentation is saved in Pdf format.

Member Function Documentation

◆ get_AccessPermissions()

virtual PdfAccessPermissions Aspose::Slides::Export::IPdfOptions::get_AccessPermissions ( )
pure virtual

Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions.

auto pdfOptions = MakeObject<PdfOptions>();
pdfOptions->set_Password(u"my_password");
auto presentation = MakeObject<Presentation>();
presentation->Save(pdfFilePath, SaveFormat::Pdf, pdfOptions);

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_AdditionalCommonFontFamilies()

virtual System::ArrayPtr<System::String> Aspose::Slides::Export::IPdfOptions::get_AdditionalCommonFontFamilies ( )
pure virtual

Returns an array of user-defined names of font families which Aspose.Slides should consider common. Read System::ArrayPtr<System::String>.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_ApplyImageTransparent()

virtual bool Aspose::Slides::Export::IPdfOptions::get_ApplyImageTransparent ( )
pure virtual

Applies the specified transparent color to an image if true.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_BestImagesCompressionRatio()

virtual bool Aspose::Slides::Export::IPdfOptions::get_BestImagesCompressionRatio ( )
pure virtual

Indicates if the most effective compression (instead of the default one) for each image must be selected automatically. If set to bool::True, for every image in presentation the most appropriate compression algorithm will be chosen, what will lead to the smaller size of the resulting PDF document.

Best image compression ratio selection is computationally expensive and takes an additional amount of RAM, and this option is bool::False by default.

Default is bool::False.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_Compliance()

virtual PdfCompliance Aspose::Slides::Export::IPdfOptions::get_Compliance ( )
pure virtual

Desired conformance level for generated PDF document. Read PdfCompliance.

Default is PdfCompliance::Pdf15.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_DrawSlidesFrame()

virtual bool Aspose::Slides::Export::IPdfOptions::get_DrawSlidesFrame ( )
pure virtual

True to draw black frame around each slide. Read bool.

Default is false.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_EmbedFullFonts()

virtual bool Aspose::Slides::Export::IPdfOptions::get_EmbedFullFonts ( )
pure virtual

Determines if all characters of font should be embedded or only used subset. Read bool.

Default is false.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_EmbedTrueTypeFontsForASCII()

virtual bool Aspose::Slides::Export::IPdfOptions::get_EmbedTrueTypeFontsForASCII ( )
pure virtual

True to embed true type fonts for ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Read bool.

Default is true.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_ImageTransparentColor()

virtual System::Drawing::Color Aspose::Slides::Export::IPdfOptions::get_ImageTransparentColor ( )
pure virtual

Gets the image transparent color.

The color of the image transparent.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_JpegQuality()

virtual uint8_t Aspose::Slides::Export::IPdfOptions::get_JpegQuality ( )
pure virtual

Returns a value determining the quality of the JPEG images inside PDF document. Read uint8_t.

Has effect only when a document contains JPEG images.

Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.

The default value is 100.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_NotesCommentsLayouting()

virtual System::SharedPtr<INotesCommentsLayoutingOptions> Aspose::Slides::Export::IPdfOptions::get_NotesCommentsLayouting ( )
pure virtual

Provides options that control how notes and comments is placed in exported document.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_Password()

virtual System::String Aspose::Slides::Export::IPdfOptions::get_Password ( )
pure virtual

Setting user password to protect the PDF document. Read System::String.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_SaveMetafilesAsPng()

virtual bool Aspose::Slides::Export::IPdfOptions::get_SaveMetafilesAsPng ( )
pure virtual

True to convert all metafiles used in a presentation to the PNG images. Read bool.

Default is true. Pdf document can contain vector graphics and raster images. If SaveMetafilesAsPng is set to true then source Metafile image is converted to Png format and saved to Pdf as a raster image. If SaveMetafilesAsPng is set to false then source Metafile is converted to Pdf vector graphics. Each approach has advantages and disadvantages.For example, if Metafile is converted to PNG, then some quality loss is possible during resulting document scaling.If Metafile is converted to Pdf vector graphics, then performance issues in Pdf viewing tool are possible.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_ShowHiddenSlides()

virtual bool Aspose::Slides::Export::IPdfOptions::get_ShowHiddenSlides ( )
pure virtual

Specifies whether the generated document should include hidden slides or not. Default is false.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_SufficientResolution()

virtual float Aspose::Slides::Export::IPdfOptions::get_SufficientResolution ( )
pure virtual

Returns a value determining resolution of images inside PDF document.

Property affects on file size, time of export and image quality.

The default value is 96.

Effect of this parameter depends on few factors. Algorithm tries to get best output image size according to the property value, source image size and image frame size. Using of similar property values may give the same result. Recommended to use step 16 or 32 to get visible effect.

Read float.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ get_TextCompression()

virtual PdfTextCompression Aspose::Slides::Export::IPdfOptions::get_TextCompression ( )
pure virtual

Specifies compression type to be used for all textual content in the document. Read PdfTextCompression.

Default is PdfTextCompression::Flate.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_AccessPermissions()

virtual void Aspose::Slides::Export::IPdfOptions::set_AccessPermissions ( PdfAccessPermissions  value)
pure virtual

Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions.

auto pdfOptions = MakeObject<PdfOptions>();
pdfOptions->set_Password(u"my_password");
auto presentation = MakeObject<Presentation>();
presentation->Save(pdfFilePath, SaveFormat::Pdf, pdfOptions);

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_AdditionalCommonFontFamilies()

virtual void Aspose::Slides::Export::IPdfOptions::set_AdditionalCommonFontFamilies ( System::ArrayPtr< System::String value)
pure virtual

Sets an array of user-defined names of font families which Aspose.Slides should consider common. Write System::ArrayPtr<System::String>.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_ApplyImageTransparent()

virtual void Aspose::Slides::Export::IPdfOptions::set_ApplyImageTransparent ( bool  value)
pure virtual

Applies the specified transparent color to an image if true.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_BestImagesCompressionRatio()

virtual void Aspose::Slides::Export::IPdfOptions::set_BestImagesCompressionRatio ( bool  value)
pure virtual

Indicates if the most effective compression (instead of the default one) for each image must be selected automatically. If set to bool::True, for every image in presentation the most appropriate compression algorithm will be chosen, what will lead to the smaller size of the resulting PDF document.

Best image compression ratio selection is computationally expensive and takes an additional amount of RAM, and this option is bool::False by default.

Default is bool::False.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_Compliance()

virtual void Aspose::Slides::Export::IPdfOptions::set_Compliance ( PdfCompliance  value)
pure virtual

Desired conformance level for generated PDF document. Write PdfCompliance.

Default is PdfCompliance::Pdf15.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_DrawSlidesFrame()

virtual void Aspose::Slides::Export::IPdfOptions::set_DrawSlidesFrame ( bool  value)
pure virtual

True to draw black frame around each slide. Write bool.

Default is false.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_EmbedFullFonts()

virtual void Aspose::Slides::Export::IPdfOptions::set_EmbedFullFonts ( bool  value)
pure virtual

Determines if all characters of font should be embedded or only used subset. Write bool.

Default is false.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_EmbedTrueTypeFontsForASCII()

virtual void Aspose::Slides::Export::IPdfOptions::set_EmbedTrueTypeFontsForASCII ( bool  value)
pure virtual

True to embed true type fonts for ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Write bool.

Default is true.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_ImageTransparentColor()

virtual void Aspose::Slides::Export::IPdfOptions::set_ImageTransparentColor ( System::Drawing::Color  value)
pure virtual

Sets the image transparent color.

The color of the image transparent.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_JpegQuality()

virtual void Aspose::Slides::Export::IPdfOptions::set_JpegQuality ( uint8_t  value)
pure virtual

Sets a value determining the quality of the JPEG images inside PDF document. Write uint8_t.

Has effect only when a document contains JPEG images.

Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.

The default value is 100.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_Password()

virtual void Aspose::Slides::Export::IPdfOptions::set_Password ( System::String  value)
pure virtual

Setting user password to protect the PDF document. Write System::String.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_SaveMetafilesAsPng()

virtual void Aspose::Slides::Export::IPdfOptions::set_SaveMetafilesAsPng ( bool  value)
pure virtual

True to convert all metafiles used in a presentation to the PNG images. Write bool.

Default is true. Pdf document can contain vector graphics and raster images. If SaveMetafilesAsPng is set to true then source Metafile image is converted to Png format and saved to Pdf as a raster image. If SaveMetafilesAsPng is set to false then source Metafile is converted to Pdf vector graphics. Each approach has advantages and disadvantages.For example, if Metafile is converted to PNG, then some quality loss is possible during resulting document scaling.If Metafile is converted to Pdf vector graphics, then performance issues in Pdf viewing tool are possible.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_ShowHiddenSlides()

virtual void Aspose::Slides::Export::IPdfOptions::set_ShowHiddenSlides ( bool  value)
pure virtual

Specifies whether the generated document should include hidden slides or not. Default is false.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_SufficientResolution()

virtual void Aspose::Slides::Export::IPdfOptions::set_SufficientResolution ( float  value)
pure virtual

Sets a value determining resolution of images inside PDF document.

Property affects on file size, time of export and image quality.

The default value is 96.

Effect of this parameter depends on few factors. Algorithm tries to get best output image size according to the property value, source image size and image frame size. Using of similar property values may give the same result. Recommended to use step 16 or 32 to get visible effect.

Write float.

Implemented in Aspose::Slides::Export::PdfOptions.

◆ set_TextCompression()

virtual void Aspose::Slides::Export::IPdfOptions::set_TextCompression ( PdfTextCompression  value)
pure virtual

Specifies compression type to be used for all textual content in the document. Write PdfTextCompression.

Default is PdfTextCompression::Flate.

Implemented in Aspose::Slides::Export::PdfOptions.